How-to guides

These guides will walk you through the processes involving setting up, maintaining, and contributing to the starter pack.

Basic setup and maintenance

Set up, configure, upgrade, and customize your project to keep it organized and aligned with your documentation needs.

• Set up Read the Docs
• Customise the setup
• Set up Sphinx sitemaps
• Customise PDF output
• Migrate from the pre-extension starter pack
• Update the documentation
• How to contribute
• Troubleshoot issues

Optional features and workflows

As your documentation grows, you may need more advanced features to support richer content. This can include diagrams as code, automated API references, and data tables.

While some of these features are available by default in the starter pack, others may require additional extensions. The following guides will help you get started:

• Create diagrams as code using Mermaid
• Create data tables
• Import docstrings with Sphinx autodoc
• Add OpenAPI integration
• Use custom templates