Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

This is the documentation for version 5.1.4 of the Awesome Theme.

Get started

  1. Install the theme:

    pip install sphinxawesome-theme

    See also

    Install the theme

  2. Add the theme to your Sphinx configuration:

    File: conf.py
    html_theme = "sphinxawesome_theme"
# recommended:
extensions += ["sphinxawesome_theme.highlighting"]

    See also

    Add the theme

  3. Build your documentation.

    See also

    Get started with Sphinx

Upgrade

If you want to upgrade to version 5.1.4 of the theme, see Upgrade to version 5.0.

Explore

In the How-to section, you can learn more about using and customizing the theme.

How To

The Demo section shows how various elements will look like.

Demo