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_themeas an HTML theme in your Sphinx configuration fileconf.py:html_theme = "sphinxawesome_theme"
For more information, see Add your theme.
Features
With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.
Awesome code blocks
-
Code block have a Copy button for copying the code.
-
You can use these additional options in
code-blockdirectives:emphasize-added. Highlight lines that should be addedemphasize-removed. Highlight lines that should be removedemphasize-text: TEXT. HighlightTEXTin the code block
Better headerlinks
Clicking the link icon after headers or captions automatically copies the URL to the clipboard.
DocSearch
This theme supports the sphinx-docsearch extension
to replace the built-in search with Algolia DocSearch.
1 maintainer
Release files for sphinxawesome-theme 6.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinxawesome_theme-6.0.5.tar.gz | 343.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinxawesome_theme-6.0.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 720.5 kB
Release files / sphinxawesome_theme-6.0.5.tar.gz
| Download URL | sphinxawesome_theme-6.0.5.tar.gz |
|---|---|
| Size | 343.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed3d82b7f0e30e3d6f38f5245d89775e9472a80a45ffd73d6a0a4b9d05ac5736
|
|
BLAKE2b-256 checksum How to use checksums |
9a3fba7f8dc2837c0ac362127c6cd491578c23ac4d4e8cc6a37726531be29256
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 15, 2026.
Transparency logRelease files / sphinxawesome_theme-6.0.5-py3-none-any.whl
| Download URL | sphinxawesome_theme-6.0.5-py3-none-any.whl |
|---|---|
| Size | 376.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c18e60b06f164f181e3ef7540a4a237f1cf4e82d8909a964e5c65e6e8293f51c
|
|
BLAKE2b-256 checksum How to use checksums |
2d5c31521b6a35410cdced12af394b715387537a262bdd1bcf08b2a34a9a4df9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 15, 2026.
Transparency log
