breathe-doc/breathe

An example of "Doxygen + Breathe + Sphinx + ReadTheDocs"

xenigmax opened this issue · 3 comments

Hello.

First of all, thank you for developing this nice extension!

I'm a member of the project named SeqAn (https://github.com/seqan/seqan) and we are trying to use Doxygen + Breathe + Sphinx + ReadTheDocs for our next version of the library.
I just found that one of your example link (http://cppformat.readthedocs.org/en/latest/) is broken, so would like to share ours although it's not completed yet. ;)

All the scripts or setting files we are using will be share in the separated repository.
https://github.com/seqan/seqan3-doc/.

Thank you again~!

Best regards,
Jongkyu

Hi,

Nice example! The chain "Doxygen + Breathe + Sphinx + ReadTheDocs" is something we use a lot at QuantStack, here are some examples:

I hope it can help!

Regards,
Johan

I think that Johan's answer is good enough for closing.

Here is a good resource walking you through the process: https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/ by @TartanLlama.

I know this is an old thread but it comes up when searching for this, and I hope this will help others in the same way it helped me.