doxyrest icon indicating copy to clipboard operation
doxyrest copied to clipboard

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

Open dirkcgrunwald opened this issue 4 years ago • 1 comments

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.

dirkcgrunwald avatar Jan 14 '22 22:01 dirkcgrunwald

If links are sufficient, you can use the :cref: directive on the classes/methods/... extracted by doxyrest, example (replace quotes with backquotes!):

:cref:'FooClass::barMethod'

See the crefdb.py file generated by doxyrest for valid ref targets.

markhh80 avatar Jan 20 '22 14:01 markhh80