• 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
  • Tutorials
    • Set up the documentation repository
    • Set up automated testing for a Sphinx-based tutorial
  • How-to guides
    • 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
      • Install prerequisites
      • Build and preview
      • Edit content
      • Get guidance
    • How to contribute
    • Troubleshoot issues
    • Create diagrams as code using Mermaid
    • Create data tables
    • Import docstrings with Sphinx autodoc
    • Add OpenAPI integration
    • Use custom templates
  • Reference
    • Automatic checks
      • Accessibility check
      • Inclusive language check
      • Link check
      • Lint check
      • Spelling check
      • Style guide linting
    • Check for removed URLs
    • reStructuredText syntax reference
    • MyST syntax guide
Back to top
Copyright © 2025 CC-BY-SA, Canonical Ltd.
Contents