Sphinx — Sphinx documentation
These sections cover various topics in using and extending Sphinx for various use-cases. They are a comprehensive guide to using Sphinx in many contexts and assume more knowledge of Sphinx.
Sphinxを使う — Sphinx documentation
このガイドでは、Sphinxを使用する方法を説明し、Sphinxのインストール、最初のSphinxプロジェクトの設定から、Sphinxが提供するいくつかの高度な機能の使用までを網羅しています。
Build your first project — Sphinx documentation
In this tutorial you will build a simple documentation project using Sphinx, and view it in your browser as HTML. The project will include narrative, handwritten documentation, as well as autogenerated API …
Installing Sphinx — Sphinx documentation
You may install a global version of Sphinx into your system using OS-specific package managers. However, be aware that this is less flexible and you may run into compatibility issues if you want to …
Getting started — Sphinx documentation
Much of Sphinx’s power comes from the richness of its default plain-text markup format, reStructuredText, along with its significant extensibility capabilities. The goal of this document is to …
Sphinx documentation contents
sphinx.ext.apidoc – Generate API documentation from Python packages sphinx.ext.autodoc – Include documentation from docstrings sphinx.ext.autosectionlabel – Allow referencing sections by their title …
Automatic documentation generation from code - Sphinx doc
Sphinx provides yet another level of automation: the autosummary extension. The autosummary directive generates documents that contain all the necessary autodoc directives.
Projects using Sphinx
This is an incomplete list of projects that use Sphinx for their documentation. If you would like to add a project, please create an issue or pull request on GitHub.
Changelog — Sphinx documentation
Feb 26, 2018 · #13751, #14089: sphinx.ext.autodoc has been substantially rewritten, and there may be some incompatible changes in edge cases, especially when extensions interact with autodoc internals.
Cross-references — Sphinx documentation
Sphinx supports various cross-referencing roles to create links to other elements in the documentation. In general, writing :role:`target` creates a link to the object called target of the type indicated by role.