# Sphinx Stack documentation

> This is the documentation for the Sphinx Stack, a template repository
> that helps you set up, build, and publish Sphinx documentation.


2026

## Pages

- [Sphinx Stack documentation](https://documentation.ubuntu.com/sphinx-stack/latest/index.html.md): The **Sphinx Stack** is a well-crafted template repository for Sphinx projects, and is
- [Set up a new project](https://documentation.ubuntu.com/sphinx-stack/latest/set-up-a-new-project/index.html.md): How to add the Sphinx Stack to a new or existing project, build the documentation locally, and set up automatic documentation checks.
- [How-to guides](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/index.html.md): Explore the essential guides and procedures in the Sphinx Stack.
- [Configure your project](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/configure-your-project/index.html.md): How to configure project-specific parameters.
- [Build and preview](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/build-and-preview/index.html.md): How to set up your environment and use make commands to build and preview documentation locally.
- [Run documentation checks](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/run-documentation-checks/index.html.md): How to verify your documentation's spelling, links, and language with built-in checks.
- [Publish on Read the Docs](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/publish-on-rtd/index.html.md): How to publish your documentation on Read the Docs.
- [Update your Sphinx Stack](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/update-sphinx-stack/index.html.md): Learn how to update your Sphinx Stack with the latest features and improvements.
- [Update the new Sphinx Stack](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/update-sphinx-stack/new-sphinx-stack/index.html.md): Learn how to update Sphinx Stack projects that use the canonical-sphinx extension.
- [Update the legacy Sphinx Stack](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/update-sphinx-stack/legacy-sphinx-stack/index.html.md): Learn how to update Sphinx Stack projects that don't yet use the canonical-sphinx extension.
- [Configure the Ulwazi theme](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/configure-ulwazi/index.html.md): How to switch to the Ulwazi theme in a documentation project based on Sphinx Stack.
- [Troubleshoot documentation issues](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/troubleshooting/index.html.md): How to troubleshoot common issues when developing documentation using the Sphinx Stack
- [Build errors](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/troubleshooting/build-errors/index.html.md): Troubleshooting guidance for issues related to building and publishing documentation using the Sphinx Stack and Read the Docs.
- [Local deployment issues](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/troubleshooting/local-deployment-issues/index.html.md): Troubleshooting guidance for issues related to running a local development environment for Sphinx Stack documentation.
- [Runtime errors](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/troubleshooting/runtime-errors/index.html.md): Troubleshooting guidance for runtime issues related to Sphinx rendering peculiarities or link configurations.
- [Read the Docs failures](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/troubleshooting/rtd-issues/index.html.md): Troubleshooting guidance for issues related to RTD builds and deployments.
- [Optional customisation](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/index.html.md): After the initial setup, you can customize your documentation to fit your project’s needs.
- [Redirect pages](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/redirect-pages/index.html.md): How to redirect URLs in your documentation project. You can redirect a URL to a page inside your project, or to a page on another website.
- [Bridge project and documentation builds](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/bridge-project-and-docs-builds/index.html.md): How to bridge the build of the Sphinx Stack and a parent project's build.
- [Enable Google Analytics](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/enable-google-analytics/index.html.md): How to enable Google Analytics in your project.
- [Customise PDF output](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/customise-pdf/index.html.md): How to customize PDF output with LaTeX.
- [Use Spread to test commands in documentation](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/add-documentation-testing/index.html.md): How to use Spread to automatically test commands in documentation and keep them in sync with your product.
- [Use custom HTML templates](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/custom-html-templates/index.html.md): How to extend or override default HTML templates to customize documentation structure and layout.
- [Add page-specific configuration](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/add-page-specific-configuration/index.html.md): How to override some global configuration for specific pages in your documentation.
- [Manage sitemaps for versioned documentation](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/manage-sitemaps/index.html.md): Validate sitemaps and publish a sitemap index for versioned documentation.
- [Create diagrams as code using Mermaid](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/mermaid-diagrams/index.html.md): How to create and embed diagrams in your documentation using Mermaid.
- [Import docstrings with Sphinx `autodoc`](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/python-docstrings/index.html.md): How to import Python docstrings automatically into your documentation using the Sphinx autodoc extension.
- [Add OpenAPI integration](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/openapi-specifications/index.html.md): How to add an OpenAPI integration to your project.
- [Add interactive data tables](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/interactive-tables/index.html.md): How to add interactive data tables to your project with sorting and filtering capabilities.
- [Link to other documentation sets with Intersphinx](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/external-referencing-intersphinx/index.html.md): Configure references to external Sphinx projects with the Intersphinx extension.
- [Customize the documentation check CI](https://documentation.ubuntu.com/sphinx-stack/latest/how-to/optional-customisation/customize-documentation-check-ci/index.html.md): How to modify the Sphinx Stack's default GitHub workflow for documentation checks.
- [Reference](https://documentation.ubuntu.com/sphinx-stack/latest/reference/index.html.md): Syntax guides, list of enabled sphinx extensions, and reference information
- [GitHub workflows](https://documentation.ubuntu.com/sphinx-stack/latest/reference/github-workflows/index.html.md): Reference for the built-in GitHub workflows that check your documentation's spelling, links, and language.
- [Default Sphinx configuration](https://documentation.ubuntu.com/sphinx-stack/latest/reference/conf-py-configuration/index.html.md): A reference of the default configuration included in the Sphinx Stack.
- [Default Sphinx extensions](https://documentation.ubuntu.com/sphinx-stack/latest/reference/default-extensions/index.html.md): A list of extensions included in the Sphinx Stack by default.
- [reStructuredText syntax](https://documentation.ubuntu.com/sphinx-stack/latest/reference/rst-syntax/index.html.md): Reference for the reStructuredText syntax conventions used by Canonical.
- [MyST syntax](https://documentation.ubuntu.com/sphinx-stack/latest/reference/myst-syntax/index.html.md): Reference for the MyST syntax conventions used by Canonical.
- [Explanation](https://documentation.ubuntu.com/sphinx-stack/latest/explanation/index.html.md): Explore topics about the concepts and ideas in the Sphinx Stack.
- [Sphinx Stack structure](https://documentation.ubuntu.com/sphinx-stack/latest/explanation/components/index.html.md): A breakdown of the constituent elements of the Sphinx Stack.
- [Build](https://documentation.ubuntu.com/sphinx-stack/latest/explanation/build/index.html.md): Learn about the function, structure, and design of the build process in the Sphinx Stack.
- [Sitemaps](https://documentation.ubuntu.com/sphinx-stack/latest/explanation/sitemaps/index.html.md): How the Sphinx Stack generates sitemaps with Read the Docs and sphinx-sitemap.
- [Release notes](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/index.html.md): This page lists the notes for past releases of the Sphinx Stack, which
- [Sphinx Stack 3.0](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/3.0/index.html.md): The new features, changes, and fixes in Sphinx Stack 3.0.
- [Canonical’s Sphinx Starter Pack 2.0](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/2.0/index.html.md): The new features, changes, and fixes in Sphinx Stack 2.0.
- [Canonical’s Sphinx Starter Pack 1.6](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/1.6/index.html.md): The new features, changes, and fixes in Canonical's Sphinx Starter Pack 1.6.
- [Canonical’s Sphinx Starter Pack 1.5](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/1.5/index.html.md): The new features, changes, and fixes in Canonical's Sphinx Starter Pack 1.5.
- [Canonical’s Sphinx Starter Pack 1.4](https://documentation.ubuntu.com/sphinx-stack/latest/release-notes/1.4/index.html.md): The new features, changes, and fixes in Canonical's Sphinx Starter Pack 1.4.0.
- [Contribute](https://documentation.ubuntu.com/sphinx-stack/latest/contribute/index.html.md): View the contribution process and ways to contribute to the Sphinx Stack. Discover the expectations and benefits of contributing.
- [Contribute to development](https://documentation.ubuntu.com/sphinx-stack/latest/contribute/development/index.html.md): How to make a code change to the Sphinx Stack. Code, test and review changes in the project within the standard workflow.
- [Contribute to documentation](https://documentation.ubuntu.com/sphinx-stack/latest/contribute/documentation/index.html.md): How to make a documentation change to the Sphinx Stack. Develop, test and review documents in the standard workflow.

## Optional

- [llms-full.txt](https://documentation.ubuntu.com/sphinx-stack/latest/llms-full.txt): Complete documentation in a single file.