Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

Get started

Note

This version of the documentation describes version 4 of the sphinxawesome-theme. Consider upgrading to version 5, which is easier to set up, offers your readers dark mode and is designed better. Because version 5 is such a big change, the documentation for version 4 is still available.

  1. Install the theme:

    terminal
    pip install sphinxawesome-theme

    See also

    Install the theme

  2. Add the theme to your Sphinx configuration:

    pythonFile: conf.py
    html_theme = "sphinxawesome_theme"
extensions = ["sphinxawesome_theme"]

    See also

    Add the theme

  3. Build your documentation.

    See also

    Get started with Sphinx

Learn more

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