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 give you a quick taste of what Sphinx is and how you might use it.
Sphinx — Sphinx documentation
These sections cover the basics of getting started with Sphinx, including creating and building your own documentation from scratch.
Installing Sphinx — Sphinx documentation
Installing Sphinx¶ Sphinx is a Python application. It can be installed in one of the ways described below. Installation methods. PyPI package. Conda package. OS-specific package manager. Linux. macOS. Windows. Docker. Installation of the latest development release. Installation from source. After installation, you can check that Sphinx is ...
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 documentation.
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 Sphinx provides out-of-the-box.
Getting started — Sphinx documentation
First steps to document your project using Sphinx; More Sphinx customization; Narrative documentation in Sphinx; Describing code in Sphinx; Automatic documentation generation from code; Appendix: Deploying a Sphinx project online; Where to go from here; User guide. Using Sphinx; Extending Sphinx; Sphinx API; LaTeX customization; Community. Get ...
Directives — Sphinx documentation
While Docutils provides a number of directives, Sphinx provides many more and uses directives as one of the primary extension mechanisms. See Domains for roles added by domains.
Sphinx 8.1 — Sphinx documentation
2024年10月12日 · #12743: Add sphinx-build--exception-on-warning, to raise an exception when warnings are emitted during the build. Patch by Adam Turner and Jeremy Maitin-Shepard.
Extensions — Sphinx documentation
The awesome-sphinxdoc and sphinx-extensions projects are both curated lists of Sphinx packages, and many packages use the Framework :: Sphinx :: Extension and Framework :: Sphinx :: Theme trove classifiers for Sphinx extensions and themes, respectively.
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 enough information to author documents productively.
- 某些结果已被删除