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.
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 …
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 …
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 …
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 …
Using Sphinx — Sphinx documentation
This guide serves to demonstrate how one can get started with Sphinx and covers everything from installing Sphinx and configuring your first Sphinx project to using some of the advanced features …
Directives — Sphinx documentation
Sphinx knows the relative order of the documents intro, strings and so forth, and it knows that they are children of the shown document, the library index. From this information it generates “next chapter”, …
Sphinx 文档目录 — Sphinx documentation
在Sphinx中描述代码 Python 其他语言（C、C++、其他） 从代码自动生成文档 使用 autodoc 重用签名和文档字符串 生成全面的 API 参考 附录：将Sphinx项目部署上线 对Sphinx友好的部署选项 拥抱“代码 …
Tutorials — Sphinx documentation
Prerequisites Writing the extension Using the extension Further reading Adding a reference domain Overview Prerequisites Writing the extension Using the extension Further reading Developing …
Example NumPy Style Python Docstrings — Sphinx documentation
This behavior can be enabled by changing the following setting in Sphinx's conf.py:: napoleon_include_special_with_doc = True …