It requires to use the following Sphinx extensions. The Sphinx configuration file conf.py used in this project is slightly different from the one used in the Doxygen CPP TriangleLib project. Note that this repository is almost identical to the code used in the Doxygen CPP TriangleLib repository, except that the Sphinx configuration file is different and it has additional reStructuredText files required for Sphinx, and an additional dependency on Breathe. The installation of the library and the building of the documentation could be found in the READMEs in the repository. The documentation corresponding to this project could be found on Read the Docs. It could be found in the Sphinx C++ TriangleLib on my GitHub. This time, we are also using the C++ Triangle library trianglelib as an example. Because Doxygen has to be used anyway for creating XML files from the annotated C/C++ source code, it is highly recommended that the reader should go through the previous two blog posts, Python Documentation Using Sphinx and C/C++ Documentation Using Doxygen, before reading this one. In this blog post, I would like to briefly describe how to use Sphinx, Breath, and Doxygen to create C/C++ documentations. It turns out that Sphinx could leverage the XML files generated by Doxygen to create the documentation for C/C++ projects by using the Sphinx extension Breathe. While creating C/C++ documentations using Doxygen is somewhat simple, Doxygen also has some kind of limitations, such as its limited number of themes and lack of customization in creating new pages, which I have mentioned in my previous blog posts. In my previous blog posts, I have described how to use Sphinx to create documentations for Python projects and how to use Doxygen to create documentations for C/C++ projects.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |