sphinxawesome-theme 1.18.0

An awesome theme for the Sphinx documentation generator

This is an awesome theme and a set of extensions for the Sphinx documentation generator. See how the theme looks on the demo page.

Features

This theme is designed with readability and usability in mind. The theme includes several extensions that enhance the usability:

Awesome code blocks

• Code blocks have a header section, displaying the optional caption, as well as the programming language used for syntax highlighting

• The code block headers contain a Copy button, allowing you to copy code snippets to the clipboard.

• The theme adds two new options to Sphinx’s code-block directive: emphasize-added and emphasize-removed, allowing you to highlight code changes within other highlighted code.

Awesome new directive for highlighting placeholder variables

The theme supports a new directive samp, which is the equivalent of the built-in :samp: interpreted text role. This allows you to highlight placeholder variables in code blocks.

Awesome user experience improvements

These small features make the theme more usable. To name a few:

• Use the Tab key to navigate through all sections of the page. Every page has a Skip to Content link to bypass navigation links.

• Link to notes, warnings, etc. Their titles have IDs and use the same “permalink” mechanism as headings and other captions.

• Better “permalink” mechanism. Hovering over an element with a permalink reveals a Link icon. Select the Link icon to copy the link to the clipboard.

• Collapsible navigation menu: all pages are reachable from all other pages.

• Collapsible code definitions: API documentation from docstrings using the sphinx.ext.autodoc extension is collapsible for a better overview.

• CSS tooltips. Provide more accessible information compared to the title attribute which only works with a mouse.

• Press the / (Slash) key to focus the search input and start searching.

Installation

Install the theme as a Python package:

$ pip install sphinxawesome-theme

Read the full installation instructions for more information.

Usage

To use the theme, set the html_theme configuration setting in the Sphinx configuration file conf.py:

html_theme = "sphinxawesome_theme"

Read the full usage information for more information.