Default Sphinx extensions

These extensions are enabled in the Starter Pack by default.

canonical_sphinx

Contains the default Canonical branded theme.

notfound.extension

Allows creating custom 404 pages. Needed by canonical_sphinx.

sphinx_design

Provides UI components like responsive grids, cards, and badges.

Needed by canonical_sphinx.

sphinx_reredirects

Handles URL redirects for moved or deleted pages.

Default Support for this extension will be dropped in an upcoming release of the Starter Pack. Update your documentation to use sphinxext-rediraffe instead.

Needed by canonical_sphinx.

sphinx_tabs.tabs

Provides tabs.

Needed by canonical_sphinx.

sphinxcontrib.jquery

Ensures jQuery is loaded to maintain compatibility with older extensions and themes.

Needed by canonical_sphinx.

sphinxext.opengraph

Generates OpenGraph metadata to create rich preview cards when links are shared on social media.

Needed by canonical_sphinx.

sphinxext-rediraffe

Handles URL redirects for moved or deleted pages. Redirects can be defined as a dictionary in the conf.py file or in a separate file.

sphinx.ext.intersphinx

Generates automatic links to the documentation objects of other Sphinx projects.

sphinx_config_options

Provides customized directives to easily document system or project configuration options.

sphinx_contributor_listing

Automatically generates a list of contributors to the project repository.

sphinx_filtered_toctree

Filters Table of Contents (toctree) entries based on specific tags or conditions.

sphinx_last_updated_by_git

Fetches and displays the accurate ‘last updated’ date for pages by reading Git commit metadata.

sphinx_related_links

Generates and injects a list of related links into documentation pages.

sphinx_roles

Provides custom inline text roles for standardized formatting or linking across the project.

sphinx_sitemap

Automatically generates a standard sitemap.xml file to improve indexing for search engine optimization (SEO).

sphinx_terminal

Renders styled terminal sessions and command-line output within the documentation.

sphinx_ubuntu_images

Generates lists of official Ubuntu disk images for specific release ranges and architectures.

sphinx_youtube_links

Provides a directive to embed YouTube videos into a page.

sphinxcontrib.cairosvgconverter

Converts SVG images into PDF.