-
Notifications
You must be signed in to change notification settings - Fork 6
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationfeature-requestNew feature requestNew feature request
Description
Abstract
The project doxyrest provides an XML->reST compiler. This can convert Doxygen-generated XML documentation into the reST format that Sphinx understands. This would allow common theming of the C++ docs, rather than just sticking the Doxygen HTML into the website. It may also allow linking via regular Docutils roles, so we don't need breathe/doxylink any longer.
Motivation
- What problem is it trying to solve?
Users and developers have noted that the distinct style of the C++ docs makes it seem like a different project and not connected to the rest of the docs. This would allow us to theme the C++ docs with the Sphinx engine that already generates the Python/Matlab docs. - Who is affected by the change?
All users of the website - Why is this a good solution?
I suppose another possible solution would be to write a Sphinx theme that fits the default Doxygen theme, or try to custom-theme the Doxygen docs. This seems a lot simpler, if it works.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentationfeature-requestNew feature requestNew feature request