Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

---

Get started

Note

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).

1. Install the theme:

   pip install sphinxawesome-theme --pre
   Copy code

   See also

   Install the theme

2. Add the theme to your Sphinx configuration:

   File: conf.py

   html_theme = "sphinxawesome_theme"
   Copy code

   See also

   Add the theme

3. Build your documentation.

   See also

   Get started with Sphinx

Upgrade

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.

Explore

How To

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

How To

• Install the theme
• Add the theme
• Configure the theme
• Customize the theme
  • Add custom CSS
  • Add custom JavaScript
  • Add custom templates
• Build your own theme

Demo

The Demo section shows how various elements will look like.

Demo

• Code documentation
• Code blocks
• On-page navigation
• Figures and tables
• Footnotes
• Inline code
• Lists
• Notes, warnings, and quotations
• Sphinx design
• Headings and text