Содержание документации Sphinx
Основы
- Установка Sphinx
- Getting started
- Build your first project
Руководство пользователя
- Using Sphinx
- reStructuredText
- Markdown
- Cross-references
- Configuration
- Builders
StandaloneHTMLBuilderDirectoryHTMLBuilderSingleFileHTMLBuilderHTMLHelpBuilderQtHelpBuilderAppleHelpBuilderDevhelpBuilderEpub3BuilderLaTeXBuilderTextBuilderManualPageBuilderTexinfoBuilderSerializingHTMLBuilderPickleHTMLBuilderJSONHTMLBuilderMessageCatalogBuilderChangesBuilderDummyBuilderCheckExternalLinksBuilderXMLBuilderPseudoXMLBuilder- Serialization builder details
- Domains
- Extensions
- HTML theming
- Локализация
- Поддержка Web в Sphinx
- Extending Sphinx
- Sphinx API
- LaTeX customization
Сообщество
- Get support
- Contribute to Sphinx
- Sphinx FAQ
- Авторы Sphinx
Ссылки
- Command-line tools
- Configuration
- Project tags
- Project information
- General configuration
needs_sphinxextensionsneeds_extensionsmanpages_urltodaytoday_fmt- Options for figure numbering
- Options for highlighting
- Options for HTTP requests
- Options for internationalisation
- Options for markup
- Options for Maths
- Options for the nitpicky mode
- Options for object signatures
- Options for source files
- Options for smart quotes
- Options for templating
- Options for warning control
- Builder options
- Options for HTML output
- Options for Single HTML output
- Options for HTML help output
- Options for Apple Help output
- Options for EPUB output
- Options for LaTeX output
- Options for text output
- Options for manual page output
- Options for Texinfo output
- Options for QtHelp output
- Options for XML output
- Options for the linkcheck builder
- Domain options
- Extension options
- Example configuration file
- Extensions
- Built-in extensions
sphinx.ext.apidoc– Generate API documentation from Python packagessphinx.ext.autodoc– Include documentation from docstringssphinx.ext.autosectionlabel– Allow referencing sections by their 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 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
- Built-in extensions
- reStructuredText
- Глоссарий
- Changelog
- Release 9.1.1 (in development)
- Release 9.1.0 (released Dec 31, 2025)
- Prior releases
- Sphinx 9.0
- Sphinx 8.2
- Sphinx 8.1
- Sphinx 8.0
- Sphinx 7.4
- Sphinx 7.3
- Sphinx 7.2
- Sphinx 7.1
- Sphinx 7.0
- Sphinx 6.2
- Sphinx 6.1
- Sphinx 6.0
- Sphinx 5.3
- Sphinx 5.2
- Sphinx 5.1
- Sphinx 5.0
- Sphinx 4.5
- Sphinx 4.4
- Sphinx 4.3
- Sphinx 4.2
- Sphinx 4.1
- Sphinx 4.0
- Sphinx 3.5
- Sphinx 3.4
- Sphinx 3.3
- Sphinx 3.2
- Sphinx 3.1
- Sphinx 3.0
- Sphinx 2.4
- Sphinx 2.3
- Sphinx 2.2
- Sphinx 2.1
- Sphinx 2.0
- Sphinx 1.8
- Sphinx 1.7
- Sphinx 1.6
- Sphinx 1.5
- Sphinx 1.4
- Sphinx 1.3
- Sphinx 1.2
- Sphinx 1.1
- Sphinx 1.0
- Sphinx 0.6
- Sphinx 0.5
- Sphinx 0.4
- Sphinx 0.3
- Sphinx 0.2
- Sphinx 0.1
- Projects using Sphinx
- Documentation using the alabaster theme
- Documentation using the classic theme
- Documentation using the sphinxdoc theme
- Documentation using the nature theme
- Documentation using another builtin theme
- Documentation using Read the Docs Sphinx Theme
- Documentation using Sphinx Bootstrap Theme
- Documentation using PyData Sphinx Theme
- Documentation using Furo theme
- Documentation using a custom theme or integrated in a website
- Homepages and other non-documentation sites
- Books produced using Sphinx
- Theses produced using Sphinx
- Projects integrating Sphinx functionality