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.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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d4f3560be607f1d9c55aab3f4a4462cf06271b0707ebc1b76b379346e37829a |
|
MD5 | 906c5f8d83a17b1cbd5df076a5983941 |
|
BLAKE2b-256 | a461cb3bd314e75aaf171070faeab9fe2c06ee191c633a0d3a396f6182a9f3ca |
Hashes for sphinxawesome_theme-5.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4638a0060fe4c282436cbbac5f1c9a94d961d34a8b47bc6f820604ae69763054 |
|
MD5 | 73489bd13b6df2bc3eab544f9ee8d257 |
|
BLAKE2b-256 | ba7ad6e17cea4e3576b9a0b388577b00a24bb1d633dcee489e0c598beb5c5b52 |