Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

Get started

  1. Install the theme:

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

    python File:
    html_theme = "sphinxawesome_theme"
    extensions = ["sphinxawesome_theme"]
  3. Build your documentation.

Learn more

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

The Demo section shows how various elements will look like.

Give feedback

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