sphinxawesome-theme 5.1.4

An awesome theme for the Sphinx documentation generator

Sphinx awesome theme

Create beautiful and awesome documentation websites with Sphinx. See how the theme looks like on sphinxawesome.xyz.

Get started

1. Install the theme as a Python package:

   pip install sphinxawesome-theme
   

   For more information, see Install the theme.

2. Add sphinxawesome_theme as an HTML theme in your Sphinx configuration file conf.py:

   html_theme = "sphinxawesome_theme"
   

   For more information, see Add your theme.

3. Recommended: add the bundled extension for more awesome code blocks:

   # conf.py
   extensions += ["sphinxawesome_theme.highlighting"]
   

Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.

Awesome code blocks

• Code block have a Copy button for copying the code.

• If you load the bundled sphinxawesome_theme.highlighting, you can use these additional options in your code-block directives:

  • emphasize-added. Highlight lines that should be added
  • emphasize-removed. Highlight lines that should be removed
  • emphasize-text: TEXT. Highlight TEXT in the code block

Better headerlinks

Clicking the link icon after headers or captions automatically copies the URL to the clipboard.

DocSearch

This theme supports the sphinx-docsearch extension to replace the built-in search with Algolia DocSearch.