An awesome theme for the Sphinx documentation generator
Project description
This is an awesome theme for the Sphinx documentation generator. See how the theme looks on the demo page.
Features
The theme includes several usability improvements:
- Better code blocks
Code blocks have a Copy button, allowing you to copy code snippets to the clipboard.
Code blocks are enhanced with emphasized-added and emphasized-removed options, that highlight removed lines in red and added lines in green.
- New directive for highlighting placeholder variables
The theme supports a new directive samp, which is the equivalent of the built-in :samp: interpreted text role. This allows you to highlight placeholder variables in code blocks.
- Improved user experience
A lot of small features make the theme more usable. To name a few:
You can tab through headlines and captions enabling easy navigation with the keyboard.
You can link to admonitions. Their titles have the same “permalink” mechanism as headlines and captions.
Clicking on the # icon for permalinks copies the link to the clipboard.
Collapsible navigation menu: All elements are reachable from all pages.
Keyboard shortcut for the search input: /.
Installation
Install the theme as a Python package:
$ pip install sphinxawesome-theme
Read the full installation instructions for more information.
Usage
To use the theme, set the html_theme configuration setting in the Sphinx configuration file conf.py:
html_theme = "sphinxawesome_theme"
Read the full usage information for more information.
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-1.13.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28ba9674a26b1ff853cf296013363e9d24cc18df05a3d51eba65cee4e39e4860 |
|
MD5 | b080fcc59f309311111b090690dc8586 |
|
BLAKE2b-256 | c8385f0df3b9c551a13b9bd0619ec45bc9c2cc499e8c1592a0c894eff608fd82 |
Hashes for sphinxawesome_theme-1.13.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3617243250ab14274b9733e196da6c87d48eac57ac00f94fc385544effde6f8 |
|
MD5 | e58a96f934dd5aec72afd82057cf9036 |
|
BLAKE2b-256 | c521a7b16ccf5d7241dce99930915f94ee86cd3b5d12e802497aa0f0531b7795 |