Sphinx awesome theme

Create beautiful and awesome documentation websites with Sphinx. See how the theme looks like on sphinxawesome.xyz.

Get started

Install the theme as a Python package:
```
pip install sphinxawesome-theme
```
For more information, see Install the theme.
Add sphinxawesome_theme as an HTML theme in your Sphinx configuration file conf.py:
```
html_theme = "sphinxawesome_theme"
```
For more information, see Add your theme.

With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.

Code block have a Copy button for copying the code.
You can use these additional options in code-block directives:
- emphasize-added. Highlight lines that should be added
- emphasize-removed. Highlight lines that should be removed
- emphasize-text: TEXT. Highlight TEXT in the code block

Clicking the link icon after headers or captions automatically copies the URL to the clipboard.

This theme supports the sphinx-docsearch extension to replace the built-in search with Algolia DocSearch.