Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

Get started

  1. Install the theme:

    shell
    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"]

    See also

    Load the theme html_theme

  3. Build your documentation with Sphinx.

    See also

    Getting started with Sphinx

In the how-to section, you can learn more about the different Theme and Extension options or Customize the theme. You can get an overview over all available styles in the demo section.

Give feedback

Is something broken or missing? Create a GitHub issue.