|
- 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 give you a quick taste of what Sphinx is and how you might use it
- 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 work across different projects
- 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 sphinx ext autosummary – Generate autodoc summaries sphinx ext coverage – Collect doc coverage stats sphinx ext doctest – Test snippets
- 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
- Configuration — Sphinx documentation
This is useful to copy files that Sphinx doesn’t copy automatically, or to overwrite Sphinx LaTeX support files with custom versions Image files that are referenced in source files (e g via image::) are copied automatically and should not be listed there
- sphinx. ext. autodoc – Include documentation from docstrings — Sphinx . . .
The regular installation process ensures that your package can be found by Sphinx and that all dependencies are available It is alternatively possible to patch the Sphinx run so that it can operate directly on the sources; e g if you want to be able to do a Sphinx build from a source checkout
|
|
|