Skip to content

Improve visual consistency and linking between Doxygen/Sphinx docs #115

@bryanwweber

Description

@bryanwweber

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfeature-requestNew feature request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions