• 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
    • Migrate from the pre-extension starter pack
    • Update the documentation
      • Install prerequisites
      • Build and preview
      • Edit content
      • Get guidance
    • How to contribute
  • Reference
    • Automatic checks
      • Accessibility check
      • Inclusive language check
      • Link check
      • Spelling check
      • Style guide linting
    • ReStructuredText cheat sheet
    • Markdown/MyST cheat sheet
    • reStructuredText style guide
    • MyST style guide
Back to top

Reference¶

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

Also see the following information:

  • Example product documentation and Example product documentation repository

  • Sphinx documentation starter pack repository

Contents¶

  • Automatic checks
  • ReStructuredText cheat sheet
  • Markdown/MyST cheat sheet
  • reStructuredText style guide
  • MyST style guide
Copyright © 2025 CC-BY-SA, Canonical Ltd.
Last updated on Mar 28, 2025
Contents
  • Reference
    • Contents