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
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.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 89f350203ca77deab73c51f7a4d04d5e17f44f8e5729ffa1710fbad7849d24dc |
|
MD5 | db9e425f0016ad79730c663408fb63b2 |
|
BLAKE2b-256 | afa6e237d1e46dbb465546ee54cabc37310b0ab63452637e4199f2ec50332538 |
Hashes for sphinxawesome_theme-5.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 926d6084fd4d3f075985641540ae4d949799cb60e0915d417695ac980ade3af0 |
|
MD5 | ac626755635c00d59ed9d850d283a53c |
|
BLAKE2b-256 | 4736d49571407f6a36e3cf7ae28f08129034695528efd49c7cc3c1dc6e901526 |