sphinxawesome-theme 1.16.1

An awesome theme for the Sphinx documentation generator

This is an awesome theme for the Sphinx documentation generator. See how the theme looks on the demo page.

Features

The theme includes several usability improvements:

Awesome code blocks

• Code blocks have a Copy button, allowing you to copy code snippets to the clipboard. They also show the programming language of the code block.

• Sphinx’s code-block directives are enhanced with emphasize-added and emphasize-removed options for highlighting added and removed lines.

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

A lot of 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.

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

• 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.