Skip to content

Can doxyrest be combined with normal sphinx documentation somewhat like breathe / exhale? #49

@dirkcgrunwald

Description

@dirkcgrunwald

I'm trying to build a documentation workflow for a set of existing projects. I tried using breathe / exhale and while I like the results there are some complications that make it less than ideal, including the long time needed to generate the results.

What I am missing or perhaps don't understand is how to combine a Sphinx-based "narrative" with the autogenerated and nicely formatted API documentation produced by doxygen / doxyrest.

Is this possible? I.e. the ability to refer to e.g. ::dxoxygenclass as in Breathe? Is there a sample that combines something like this? The samples directly seems to only include the doxygen XML outputs so I'm having a problem finding an example to follow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions