Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

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

Get started

  1. Install the theme:

    pip install sphinxawesome-theme
  2. Add the theme to your Sphinx configuration:

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

    See also

    Add the theme

  3. Build your documentation.


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