Sphinx + Doxygen + Breathe: How can I get documentation similar to the one in Google Ceres Solver?

Question

I am working on a C ++ project and really fell in love with the Sphinx documentation assembly system. I was able to configure Doxygen and Breathe to create and provide C ++ descriptions for Sphinx.

I cannot understand how the Google Ceres Solver documentation was implemented. Their API link contains, for example, class names followed by a lot of text, sometimes even with code examples, as shown in the previous link. Is there a way to write Doxygen documentation inside the source files and achieve this?

Another example is this class documentation , which contains about two pages of text. For some reason, I doubt that all this text is in the source files as Doxygen comments. I have the feeling that all the additional text was written in restructured text sources for documentation and nothing in the C ++ source files. But then what's the point of using oxygen and breathing ...

Or try differently, where should I put high-level code information ? I mean, I can document class1and class2in its sources, but somewhere I need to explain how they interact and are used together. This is what, in my opinion, the Ceres Solver documentation does a great job of.

Alternatively, you can point me to a C ++ project with the Sphinx + Doxygen + Breathe pipeline and open source documentation. Then I myself see how to do it. Unfortunately, I do not know about any project.

Answer 1

I missed the github link for Ceres Solver. There you can find sources of documentation. I am a little disappointed because the full documentation is written in the structured text source files and NOT inside C ++ code. They basically refer to the class name with .. class:: className, and then add a ReST markdown for the info text, examples of code blocks, etc. One example is given in "Modeling Nonlinear Least Squares"