An awesome theme for the Sphinx documentation generator
Project description
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 fileconf.py
:html_theme = "sphinxawesome_theme"
For more information, see Add your theme.
-
Recommended: add the bundled extension for more awesome code blocks:
# conf.py extensions += ["sphinxawesome_theme.highlighting"]
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.
-
If you load the bundled
sphinxawesome_theme.highlighting
, you can use these additional options in yourcode-block
directives:emphasize-added
. Highlight lines that should be addedemphasize-removed
. Highlight lines that should be removedemphasize-text: TEXT
. HighlightTEXT
in 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
to replace the built-in search with Algolia DocSearch.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxawesome_theme-5.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcf07f149f211244d921a596940956e576248760e48526f67ee62191c6d3a058 |
|
MD5 | f0e5a68d3c2410abf358d147e5b9b2d5 |
|
BLAKE2b-256 | 3908758fdddd9c63e620719da4a02ddf1840f197a77f020117161f53c5ee78b8 |
Hashes for sphinxawesome_theme-5.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8eee609f7b9e45773516fc52e7b587a94f29d80571449670b540d82f23a6eadf |
|
MD5 | b3854fcc038eb54fc4261dc896219c97 |
|
BLAKE2b-256 | 37d1ede368f368a52420468c70bd65de8999e41a3d0a247ce9d2a6265db4a85f |