Sphinx extensions
Sphinx extensions#
We use several Sphinx extensions to enhance the presentation of OpenSPP documentation.
sphinx.ext.graphvizallows you to embed Graphviz graphs in your documents.sphinx.ext.intersphinxprovides linking between separate projects that use Sphinx for documentation.sphinx.ext.todoadds support for todo items.sphinx_copybuttonadds a little "copy" button to the right of code blocks.sphinx-designadds grids, cards, icons, badges, buttons, tabs, and dropdowns.sphinx_sitemapgenerates multiversion and multilanguage sitemaps.org compliant sitemaps.sphinxcontrib.httpdomainprovides a Sphinx domain for describing HTTP APIs.sphinxcontrib.httpexampleenhancessphinxcontrib-httpdomainby generating RESTful HTTP API call examples for different tools from a single HTTP request example. Supported tools include curl, wget, httpie, and python-requests.sphinxcontrib.videoallows you to embed local videos as defined by the HTML5 standard.sphinxext.opengraphgenerates OpenGraph metadata.sphinx.ext.viewcodegenerates pages of source code modules and links between the source and the description.sphinx.ext.autosummarygenerates function/method/attribute summary lists.
openspp.org