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 …
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 …
Sphinxを使う — Sphinx documentation
このガイドでは、Sphinxを使用する方法を説明し、Sphinxのインストール、最初のSphinxプロジェクトの設定から、Sphinxが提供するいくつかの高度な機能の使用までを網羅しています。
Sphinx documentation contents
Sphinx documentation contents The Basics Installing Sphinx PyPI package Conda package OS-specific package manager Linux macOS Windows Docker Installation of the latest …
安装Sphinx — Sphinx documentation
在本地进行开发，通常建议将 Sphinx 安装在非全局环境中（例如使用 venv 或 conda 环境）。 这将允许每个 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 …
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 …
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.
reStructuredText Primer — Sphinx documentation
reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, intended to provide authors with …
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.