Extensions¶
Since many projects will need special features in their documentation, Sphinx allows adding «extensions» to the build process, each of which can modify almost any aspect of document processing.
This chapter describes the extensions bundled with Sphinx. For the API documentation on writing your own extension, refer to Sphinx Extensions API.
Built-in extensions¶
Estas extensiones están incorporadas y pueden ser activadas por entradas respectivas en el valor de configuración: extensions
sphinx.ext.autodoc
– Include documentation from docstringssphinx.ext.autosectionlabel
– Allow reference sections using its titlesphinx.ext.autosummary
– Generate autodoc summariessphinx.ext.coverage
– Recoge estadísticas de la cobertura de la documentaciónsphinx.ext.doctest
– Test snippets in the documentationsphinx.ext.duration
– Measure durations of Sphinx processingsphinx.ext.extlinks
– Markup to shorten external linkssphinx.ext.githubpages
– Publicar documentación HTML en GitHub Pagessphinx.ext.graphviz
– Add Graphviz graphssphinx.ext.ifconfig
– Include content based on configurationsphinx.ext.imgconverter
– A reference image converter using Imagemagicksphinx.ext.inheritance_diagram
– Include inheritance diagramssphinx.ext.intersphinx
– Link to other projects” documentationsphinx.ext.linkcode
– Add external links to source code- Math support for HTML outputs in Sphinx
sphinx.ext.napoleon
– Support for NumPy and Google style docstringssphinx.ext.todo
– Support for todo itemssphinx.ext.viewcode
– Add links to highlighted source code
Third-party extensions¶
You can find several extensions contributed by users in the sphinx-contrib organization. If you wish to include your extension in this organization, simply follow the instructions provided in the github-administration project. This is optional and there are several extensions hosted elsewhere. The awesome-sphinxdoc and sphinx-extensions projects are both curated lists of Sphinx packages, and many packages use the Framework :: Sphinx :: Extension and Framework :: Sphinx :: Theme trove classifiers for Sphinx extensions and themes, respectively.
Where to put your own extensions?¶
Extensions local to a project should be put within the project’s directory
structure. Set Python’s module search path, sys.path
, accordingly so that
Sphinx can find them. For example, if your extension foo.py
lies in the
exts
subdirectory of the project root, put into conf.py
:
import sys, os
sys.path.append(os.path.abspath('exts'))
extensions = ['foo']
You can also install extensions anywhere else on sys.path
, e.g. in the
site-packages
directory.