Autodocs

Testing doxygen/sphinx pipeline for aiutomatic generation of documentation

Env setup

How to generate

''' cd doc make html '''

Links

A 3 part post on how to setup doxygen/breath/sphinx for displaying documentation from markdwn + API docs generated by doxygen in xml format into the readthedocs sphinx template

https://medium.com/practical-coding/c-documentation-with-doxygen-cmake-sphinx-breathe-for-those-of-use-who-are-totally-lost-7d555386fe13

https://brunowu.github.io/doxygen_sphinx_example/build.html#building-documentation

A short blog post on doxygen/sphinx/breathe

https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

About Read the docs https://about.readthedocs.com/

Sphinx material theme

https://github.com/bashtage/sphinx-material/tree/main

https://bashtage.github.io/sphinx-material/specimen.html

Myst for parsing markdown document

https://myst-parser.readthedocs.io/en/v0.17.1/sphinx/intro.html

Sphynx

https://www.sphinx-doc.org

Generate on gitlab CI

https://bioinfo-fr.net/comment-creer-une-documentation-automatique-avec-doxygen-et-sphinx-en-ci-cd-gitlab

Docstrings in Python

https://www.dataquest.io/blog/documenting-in-python-with-docstrings/

Doxygen

https://www.doxygen.nl/index.html

Tips and tricks

To have a hierarchy in the code's documentation
- in the root's index.rst (in doc) load thr root's api/index.rst
- in this index.rst, put the API title with 3 = below
- in this file, load all files with glob (load in alphabetic order)
- in each sub rst filem have the title (CPP and Python) with the same numer of = as letters
  - in the example_google.py

Recommend Projects