Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

Get started

  1. Install the theme:

    terminal
    pip install sphinxawesome-theme

    See also

    Install the theme

  2. Add the theme to your Sphinx configuration:

    python File: conf.py
    html_theme = "sphinxawesome_theme"
extensions = ["sphinxawesome_theme"]

    See also

    Load the theme html_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

Give feedback

Is something not working or do you miss a feature? Create a GitHub issue.