Awesome Sphinx Theme
Create functional and beautiful websites for your documentation with Sphinx.
You’re viewing the documentation for version 5.0.0b2 of the Awesome Theme,
which is a beta release.
That’s why you have to add
--pre to the installation command.
To read the documentation for the latest stable release, see Awesome Sphinx Theme (version 4).
Install the theme:
pip install sphinxawesome-theme --pre
Add the theme to your Sphinx configuration:
html_theme = "sphinxawesome_theme"
Build your documentation.
If you want to upgrade to version 5.0.0b2 of the theme, see Upgrade to version 5.0. If you don’t want to upgrade, you can read the documentation for version 4.
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.