| | |
|
a | |
|
sphinx.addnodes |
|
|
sphinx.application |
Application class and extensibility interface. |
| | |
|
b | |
 |
sphinx.builders |
Available built-in builder classes. |
|
sphinx.builders.changes |
|
|
sphinx.builders.dirhtml |
|
|
sphinx.builders.dummy |
|
|
sphinx.builders.epub3 |
|
|
sphinx.builders.gettext |
|
|
sphinx.builders.html |
|
|
sphinx.builders.latex |
|
|
sphinx.builders.linkcheck |
|
|
sphinx.builders.manpage |
|
|
sphinx.builders.singlehtml |
|
|
sphinx.builders.texinfo |
|
|
sphinx.builders.text |
|
|
sphinx.builders.xml |
|
| | |
|
c | |
|
conf |
Build configuration file. |
| | |
|
d | |
|
docutils |
|
|
docutils.parsers.rst |
|
|
sphinx.directives |
|
|
sphinx.domains |
|
|
sphinx.domains.python |
|
| | |
|
e | |
|
sphinx.environment |
|
|
sphinx.environment.collectors |
|
|
sphinx.errors |
|
|
sphinx.ext |
|
|
sphinx.ext.autodoc |
Include documentation from docstrings. |
|
sphinx.ext.autosectionlabel |
Allow referencing sections by their title. |
|
sphinx.ext.autosummary |
Generate autodoc summaries |
|
sphinx.ext.coverage |
Check Python modules and C API for coverage in the documentation. |
|
sphinx.ext.doctest |
Test snippets in the documentation. |
|
sphinx.ext.duration |
Measure durations of Sphinx processing |
|
sphinx.ext.extlinks |
Allow inserting external links with common base URLs easily. |
|
sphinx.ext.githubpages |
Publish HTML docs in GitHub Pages |
|
sphinx.ext.graphviz |
Support for Graphviz graphs. |
|
sphinx.ext.ifconfig |
Include documentation content based on configuration values. |
|
sphinx.ext.imgconverter |
Convert images to appropriate format for builders |
|
sphinx.ext.imgmath |
Render math as PNG or SVG images. |
|
sphinx.ext.inheritance_diagram |
Support for displaying inheritance diagrams via graphviz. |
|
sphinx.ext.intersphinx |
Link to other Sphinx documentation. |
|
sphinx.ext.jsmath |
Render math using JavaScript via JSMath. |
|
sphinx.ext.linkcode |
Add external links to source code. |
|
sphinx.ext.mathbase |
Common math support for imgmath and mathjax / jsmath. |
|
sphinx.ext.mathjax |
Render math using JavaScript via MathJax. |
|
sphinx.ext.napoleon |
Support for NumPy and Google style docstrings |
|
sphinx.ext.todo |
Allow inserting todo items into documents. |
|
sphinx.ext.viewcode |
Add links to a highlighted version of the source code. |
| | |
|
l | |
|
latex |
LaTeX specifics. |
| | |
|
p | |
|
sphinx.parsers |
|
| | |
|
s | |
|
sphinxcontrib |
|
|
sphinxcontrib.applehelp |
|
|
sphinxcontrib.devhelp |
|
|
sphinxcontrib.htmlhelp |
|
|
sphinxcontrib.qthelp |
|
| | |
|
t | |
|
sphinx.testing |
Utility functions and pytest fixtures for testing. |
