Useful Sphinx extensions¶
Here are a few extensions that we have found useful:
- “sphinx_gallery.gen_gallery”Builds a gallery of examples in HTML
Run Python scripts and capture output and figures.
“nbsphinx” : render Jupyter notebooks
“sphinx.ext.intersphinx” : Cross-reference between different Read the Docs projects
“breathe” : Render doxygen generated documentation
“sphinxcontrib.mermaid” : Create mermaid diagrams
“sphinx.ext.mathjax” : Render LaTex formatted equations
“sphinx.ext.autodoc” : Render Python API docstrings
“sphinx.ext.napoleon” : Render NumPy and Google styled docstrings
See more here