Document how to integrate with Doxygen

[JoelMarcey]

📚 Documentation

Clear and explicit documentation on how to integrate Doxygen-generated APIs.

Have you read the Contributing Guidelines on issues?

Yes

Motivation

#942

Pitch

For those that build Doxygen based API docs so that the resulting HTML can be used with Docusaurus should know where to put the files (e.g., static/api) and that you may want to use the separateCSS site config option so that any CSS with the documentation gets copied directly over on build, instead of concatenated.

separateCss - Directories inside which any css files will not be processed and concatenated to Docusaurus' styles. This is to support static html pages that may be separate from Docusaurus with completely separate styles.

[tianhaoz95]

I am facing the same issue with jsdoc, i put 'static/api' inside separateCSS, but not working, the css files are still missing. any more information on this?

[yangshun]

@tianhaoz95 I think it should be separateCss (lower case ss). Try that?

[slorber]

This is initially a v1 issue

v2 has different ways, to integrate:

• Put things in /static
• Use MDX and add an iframe to some doc page
• Build a plugin

Doxygen is one solution to generate HTML files from APIs, and there are many. I don't think we should document Doxygen in particular, or be exhaustive about all the solutions that can be integrated with Docusaurus.

Similar issue on how to integrate openapi/swagger for REST apis: #638

[slorber]

The Docusaurus team is actively working on Docusaurus v2.

After a very long alpha, Docusaurus v2 is now in beta.
We believe that the v2 beta is already better than v1, and v2 is ready for maintstream adoption.

Apart from critical issues and security fixes, we don't plan to invest much time on Docusaurus v1 anymore.

We are all closing v1 issues.
Maybe the current issue is already fixed in Docusaurus v2.
Please try to upgrade, and if the issue is still there on Docusaurus v2, open a new issue.