sphinxawesome-theme 1.0.1

A simple theme for a Sphinx documentation

This is a simple but awesome theme for the Sphinx documentation generator.

Installation

Install the theme as a Python package:

pip install sphinxawesome-theme

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

html_theme = "sphinxawesome_theme"

Configuration

To show also entries in the navigation menu from toctree directives with the :hidden: option, add the following setting to the Sphinx configuration file conf.py.

html_theme_options = {"nav_include_hidden": True}

Including :hidden: in a toctree directive makes Sphinx include the documents, but not print the list of links to the documents on the current page. This is useful when navigation links are shown elsewhere, for example in a menu on the left side. The default is nav_include_hidden=False in order to be compatible with other themes.

Limitations

This theme is designed to be simple. Some features are not (or not yet) available.

• Zero custom theme variables to modify styles.

• API documentation has not been tested. Some styles are missing.

• Not all docutils/Sphinx roles have styles. There are a lot of them.

• Internationalization was neglected.

Documentation

Read the documentation and see how the theme looks on the demo page