A pre-configured repository to build and publish documentation with Sphinx.
The Documentation starter pack includes:
- A bundled Sphinx theme, configuration, and extensions
- Support for both reStructuredText (reST) and MyST Markdown
- Build checks for links, spelling, and inclusive language
- Customisation support layered over a core configuration
See the full documentation: https://canonical-starter-pack.readthedocs-hosted.com/
This section outlines the structure of this repository, and some key files.
This directory contains the documentation for the starter pack itself. To view it in your browser, change to this directory and type make run.
This directory contains files used to test the functionality of the starter pack project.