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.
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-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
extension
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.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4e66ce6aa0db225315246c6c1404052ff2c1484d1c2f1eea7a5ce23ed24f0574 |
|
MD5 | ff33f3c0667fe7999870923c40779af5 |
|
BLAKE2b-256 | a73632983e03d77503f35e18e0a8f1850cf36e320d014a18d2c7c4391c11298f |
Hashes for sphinxawesome_theme-5.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9cd84a53ee9146b09553f2d59f778bbcafa4fc58ce1bad4c876c5a6898c8907e |
|
MD5 | 714a8dcb394faecaf447a6481d6c7afe |
|
BLAKE2b-256 | f6daf9ed656e7a282060c2381e96eae1281663df712c08e6d4f5ec2bfaca9603 |