Learn how to add the Awesome Theme to your Sphinx documentation.
To use the Awesome Theme in your documentation:
html_themeconfiguration option to your Sphinx configuration file
sphinxawesome_themeas an extension to your Sphinx configuration:
Loading the Awesome Theme as an extension activates the internal Sphinx extensions that enhance the user experience.
If you want to keep your documentation and theme as a single project, you can load the Awesome Theme from a local directory. This can be useful if you want to customize the theme.
When loading the theme from a local directory, you need to manage the dependencies
yourself. This theme needs the
beautifulsoup package to run. You can install it with
pip install bs4
The following example assumes you have a Sphinx project with the following structure,
and you want to load the theme from the
./ ├── conf.py ├── index.rst ├── _themes/ └── ...
To load the theme from a local directory, follow these steps:
Copy the directory
sphinxawesome-theme/src/sphinxawesome_theme/into your Sphinx project:terminal
cp -r sphinxawesome-theme/src/sphinxawesome_theme _themes/
_themes/directory to the system path in the Sphinx configuration:
Adding this directory makes it discoverable for Sphinx.
_themes/directory to the
This prevents Sphinx from searching the
_themes/directory for documentation files.
Add the theme as an extension and as a theme: