Documentation starter pack¶
The documentation starter pack helps you to quickly set up, build, and publish documentation with Sphinx.
It contains common styling and configuration through the Canonical Sphinx extension, supports both reST and Markdown, and includes automatic documentation checks.
In this documentation¶
Get started
Set up the Sphinx starter pack in your project for the first time.
How-to guides
Step-by-step guides - learn key operations and customisation.
Reference
Technical information - review the automatic checks and Sphinx capabilities.
Explanation
Concepts - understand the design and architecture of the starter pack.
Project and community¶
The Canonical Sphinx starter pack is an open source project that warmly welcomes community contributions, suggestions, fixes and constructive feedback.