sphinxawesome-theme 1.12.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:

Copy code blocks

Code blocks have a Copy button, allowing you to copy code snippets to the clipboard.

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.

Improved user experience

A lot of small features make the theme more usable. To name a few:

• You can tab through headlines and captions enabling easy navigation with the keyboard.

• You can link to admonitions. Their titles have the same “permalink” mechanism as headlines and captions.

• Clicking on the # icon for permalinks copies the link to the clipboard.

• Collapsible navigation menu: All elements are reachable from all pages.

• Keyboard shortcut for the search input: /.

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 html_theme in the Sphinx configuration file conf.py:

html_theme = "sphinxawesome_theme"

Read the full usage information for more information.