Sphinx documentation
E888271
Sphinx documentation is the official and user-generated reference material that explains how to use the Sphinx tool to create, configure, and build structured software documentation.
Statements (89)
| Predicate | Object |
|---|---|
| instanceOf |
online documentation
ⓘ
reference manual ⓘ software documentation ⓘ |
| about | Sphinx (documentation generator) NERFINISHED ⓘ |
| availableAs |
HTML
NERFINISHED
ⓘ
PDF ⓘ epub ⓘ man pages ⓘ |
| coversTopic |
HTML output
ⓘ
HTML theme options ⓘ LaTeX output ⓘ Sphinx API NERFINISHED ⓘ Sphinx builders ⓘ Sphinx changelog NERFINISHED ⓘ Sphinx command-line interface ⓘ Sphinx configuration file conf.py ⓘ Sphinx configuration options ⓘ Sphinx environment ⓘ Sphinx extensions ⓘ Sphinx project structure ⓘ Sphinx roles and directives NERFINISHED ⓘ Sphinx themes NERFINISHED ⓘ Sphinx theming and templates ⓘ autodoc configuration ⓘ autodoc extension ⓘ builder names and options ⓘ configuration values reference ⓘ cross-references ⓘ doctest builder ⓘ doctest integration ⓘ domain-specific directives ⓘ extensions index ⓘ how-to guides ⓘ index generation ⓘ internationalization ⓘ intersphinx extension ⓘ intersphinx mapping ⓘ link checking ⓘ linkcheck builder ⓘ localization ⓘ man page output ⓘ nitpicky mode ⓘ reStructuredText markup ⓘ reference guides ⓘ sphinx-build command ⓘ sphinx-quickstart command ⓘ table of contents trees ⓘ tutorials for new users ⓘ type hints in documentation ⓘ versioning of documentation ⓘ writing extensions for Sphinx ⓘ |
| describes |
how to build documentation with Sphinx
ⓘ
how to configure Sphinx ⓘ how to use Sphinx ⓘ |
| hasPart |
Sphinx FAQ
NERFINISHED
ⓘ
Sphinx builders reference NERFINISHED ⓘ Sphinx changelog NERFINISHED ⓘ Sphinx configuration reference ⓘ Sphinx domain reference NERFINISHED ⓘ Sphinx examples ⓘ Sphinx extension API reference NERFINISHED ⓘ Sphinx glossary ⓘ Sphinx installation guide NERFINISHED ⓘ Sphinx internals documentation NERFINISHED ⓘ Sphinx internationalization guide NERFINISHED ⓘ Sphinx man pages ⓘ Sphinx roles and directives reference NERFINISHED ⓘ Sphinx theming guide NERFINISHED ⓘ Sphinx tutorial ⓘ Sphinx user guide NERFINISHED ⓘ |
| hostedAt | https://www.sphinx-doc.org/ ⓘ |
| includes |
community-contributed documentation
ⓘ
official documentation ⓘ |
| language | English ⓘ |
| license | BSD-style license (for Sphinx project) ⓘ |
| maintainedBy |
Sphinx community
NERFINISHED
ⓘ
Sphinx developers NERFINISHED ⓘ |
| primaryAudience |
documentation engineers
ⓘ
software developers ⓘ technical writers ⓘ |
| relatedTo |
Python documentation ecosystem
ⓘ
Read the Docs hosting NERFINISHED ⓘ documentation-as-code practices ⓘ reStructuredText documentation ⓘ |
| usedFor |
configuring Sphinx projects
ⓘ
customizing Sphinx themes ⓘ developing Sphinx extensions ⓘ learning Sphinx ⓘ troubleshooting Sphinx builds ⓘ |
Referenced by (1)
Full triples — surface form annotated when it differs from this entity's canonical label.