How to use Sphinx Documentation

Sphinx documentation build also requires configuring the source pathname inside docs/conf.py So, the process for building documentation is: Run sphinx-quickstart, e.g. sphinx-quickstart docs/ -p xmmPipeline -a Suyog –ext-autodoc –ext-napolean –ext-doctest –ext-intersphinx –ext-todoint Edit docs/conf.py file to have the correct documentation path. Run autodoc to automatically import the docstring from the code modules and scripts, e.g. sphinx-apidoc -o ./docs ../src/xmmPipeline/ –force Use make html for HTML, make latex for LaTeX, make latexpdf for PDF and make epub for epub...

 February 13, 2023  •   2 min  •   345 words  •   Suyog Garg