Is Sphinx already suitable for C++ documentation?

clstaudt picture clstaudt · Oct 17, 2012 · Viewed 26.3k times · Source

I want to try out documentation generators for a new project in C++. I think my options are either Doxygen or Sphinx. Since I have projects in Python for which I'd like to use Sphinx, I wonder whether Sphinx is the right choice for C++ as well. The Sphinx website states that C++ is supported, but I could not find a document to get me started with C++ documentation.

A similar question has already been discussed on Stackoverflow and the main answer concludes:

not yet fully usable,
but keep watching

Since the discussion is well over a year old, I wonder whether this conclusion is still valid. Should I choose Doxygen over Sphinx for my C++ documentation?

Answer

lunaryorn picture lunaryorn · Oct 18, 2012

Sphinx cannot extract documentation from C++ sources in and by itself. However, there are extensions, most notably Breathe, which utilize Doxygen to extract documentation from C++. I've not tested any of these.