search

vovkos / doxyrest

A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
MIT License
306 stars 23 forks source link

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

Open dirkcgrunwald opened 2 years ago

dirkcgrunwald commented 2 years ago

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.

markhh80 commented 2 years ago

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.