sphinxawesome-theme 4.1.0

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

To use this theme in your project, install it via pip and add it to your Sphinx configuration.

1. Install the theme as a Python package:

   pip install sphinxawesome-theme
   

   For more information, see How to install the theme.

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

   html_theme = "sphinxawesome_theme"
   extensions = ["sphinxawesome_theme"]
   

   For more information, see How to load the theme for more information.

Features

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites. These features make your documentation awesome:

Awesome code blocks

Code blocks show the language of the code in a header. Each code block has a Copy button for easy copying. This theme enhances Sphinx's code-block directive with these options:

• emphasize-added. Highlight lines that should be added to code
• emphasize-removed. Highlight lines that should be removed from the code
• emphasize-text: TEXT. Highlight TEXT in the code block to emphasize placeholder text the user should replace.

Better headerlinks

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

DocSearch

If you have an Algolia DocSearch account for your documentation, you can use DocSearch for a search-as-you-type experience with autocomplete. Algolia DocSearch is free for open source documentation projects.

Better keyboard navigation

Use the Tab key to skip through all sections on the page. Use the Space key to expand or collapse items in the navigation menu or in code definitions.