Awesome Sphinx Theme

Create functional and beautiful websites for your documentation with Sphinx.

---

This is the documentation for version 6.0.0b3 of the Awesome Theme.

Get started

1. Install the theme:

   pip install sphinxawesome-theme
   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, Configure the theme

3. Build your documentation.

   See also

   Get started with Sphinx

Upgrade

If you want to upgrade to version 6.0.0b3 of the theme, see Changelog.

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
• Equations
• Jupyter notebooks
• Notes, warnings, and quotations
• Page without right sidebar
• Sphinx design
• Headings and text