Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dirkcgrunwald opened this issue Jan 14, 2022 · 1 comment

Comments

@dirkcgrunwald
Copy link

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
Copy link

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants