How-to guides

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

Basic setup and maintenance

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

• Configure your project
• Build and preview
• Run documentation checks
• Publish on Read the Docs
• Update your Sphinx Stack
• Troubleshooting

Optional features and customisation

As your documentation grows, you may need more advanced features to support richer content. This can include customising the build system, adding diagrams as code, rendering API references, interactive tables, and custom HTML.

While some of these features are available by default in the Sphinx Stack, others may require additional extensions.

The following guides will help you get started:

• Optional customisation
  • Redirect pages
  • Bridge project and docs builds
  • Enable Google Analytics
  • Customise PDF output
  • Use Spread to test commands in documentation
  • Use custom HTML templates
  • Add Mermaid diagrams
  • Add Python docstrings
  • Add OpenAPI specifications
  • Add interactive tables
  • Link to other documentation sets with Intersphinx