Extensions a ArviZ i a PyMC#
Extensions integrades#
Les extensions integrades utilitzen el prefix sphinx.ext.
autodoc
iautosummary
automatitzen la inclusió de docstrings a la documentació.viewcode
afegeix l’enllaç[source]
a les pàgines de la API generades ambautosummary
mathjax
configura mathjax per tal que les fórmules matemàtiques es vegin correctament en format html.intersphinx
permet referències encreuades a pàgines de documentacions externes.
Extensions externes#
numpydoc
interpreta els docstrings escrits amb l’estil NumPyLes extensions de
IPython
afegeixen directrius per incloure codi executat automaticament en construir la documentació i ressaltament per a aquests blocs de codi.matplotlib.sphinxext.plot_directive
ibokeh.sphinxext.bokeh_plot
afegeixen directrius per incrustar gràfiques a la documentació.myst
imyst_nb
permeten a Sphinx interpretar fitxers.md
i.ipynb
.sphinx_design
afegeix varis rols i directrius per formatació com ara quadrícules, pestanyes o cartes basades en bootstrap, icones d’octicon i font awesome…sphinx_copybutton
afegeix automàticament una icona per copiar blocs de codi amb un clic.sphinx_togglebutton
(pulled in under the hood bymyst_nb
) activa arguments i etiquetes en certes directrius i cel·les de codi per tal d’afegir «botons commutadors» o amagar contingut.notfound.extension
millora el suport per pàgines d’error 404 personalitzades, especialment quan la web de la documentació està allotjada a GitHub pages o a ReadTheDocs.ablog
afegeix una directriu «post» per a publicacions que permet incloure etiquetes, categories, data de publicació i crea arxius automàticament, núvols d’etiquetes…sphinxcontrib.bibtex
afegeix rols i directrius per a funcionalitats de citació a l’estil latex i suport per referències en format bibtex.sphinx-codeautolink
enllaços automàtics en blocs de codi.
Extensions «casolanes»#
Tot i que formen part del codi d’ArviZ/PyMC, s’hauria d’esperar treballar en aquestes extensions encara menys sovint que treballar en conf.py
.
gallery_generator
(ArviZ) runs all the files within theexamples/
folder and automatically builds the Example gallery page from them. for the Tutorials and Examples sections.