Get started
User Guides
sphinx.ext.autodoc – Include documentation from docstringssphinx.ext.autosectionlabel – Allow reference sections using its titlesphinx.ext.autosummary – Generate autodoc summariessphinx.ext.coverage – Collect doc coverage statssphinx.ext.doctest – Test snippets in the documentationsphinx.ext.duration – Measure durations of Sphinx processingsphinx.ext.extlinks – Markup to shorten external linkssphinx.ext.githubpages – Publish HTML docs in 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 codesphinx.ext.napoleon – Support for NumPy and Google style docstringssphinx.ext.todo – Support for todo itemssphinx.ext.viewcode – Add links to highlighted source codeCommunity
Reference
sphinx.ext.autodoc – Include documentation from docstringssphinx.ext.autosectionlabel – Allow reference sections using its titlesphinx.ext.autosummary – Generate autodoc summariessphinx.ext.coverage – Collect doc coverage statssphinx.ext.doctest – Test snippets in the documentationsphinx.ext.duration – Measure durations of Sphinx processingsphinx.ext.extlinks – Markup to shorten external linkssphinx.ext.githubpages – Publish HTML docs in 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 codesphinx.ext.napoleon – Support for NumPy and Google style docstringssphinx.ext.todo – Support for todo itemssphinx.ext.viewcode – Add links to highlighted source codesphinx.ext.githubpages – Publish HTML docs in GitHub Pages¶Added in version 1.4.
Zmienione w wersji 2.0: Support CNAME file
This extension creates .nojekyll file on generated HTML directory to publish
the document on GitHub Pages.
It also creates a CNAME file for custom domains when html_baseurl
set.