• Logo
    Documentation starter pack
  • documentation.ubuntu.com
  • More resources
    • Discourse
    • Mattermost
    • Matrix
    • GitHub
Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Documentation starter pack documentation
Documentation starter pack documentation
  • Set up a new project
  • How-to guides
    • Configure your project
    • Build and preview
    • Publish on Read the Docs
    • Enable Google Analytics
    • Update your starter pack
      • New starter pack
      • Legacy starter pack
    • Test the Ulwazi theme
    • Troubleshooting
    • Optional customisation
      • Bridge project and docs builds
      • 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
  • Reference
    • Automatic checks
      • Accessibility check
      • Inclusive language check
      • Link check
      • Lint check
      • Check for removed URLs
      • Spelling check
      • Style guide linting
    • Default Sphinx extensions
    • reStructuredText syntax
    • MyST syntax
  • Explanation
    • Starter pack structure
    • Build
    • Sitemaps
  • Release notes
    • 1.6
    • 1.5
    • 1.4
Back to top

Reference¶

These documents provide an overview of different features of the starter pack.

Also see the following information:

  • Sphinx documentation starter pack repository

Contents¶

  • Automatic checks
  • Default Sphinx extensions
  • reStructuredText syntax
  • MyST syntax
© 2026 Canonical Ltd.
This page is licensed under CC-BY-SA-3.0
Last updated on Mar 30, 2026
Contents
  • Reference
    • Contents