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:
- Copy code blocks
Code blocks have a Copy button, that allows you to copy code snippets to the clipboard.
- Improved links after section titles and captions (“permalinks”)
Clicking on the # character that appears when hovering over headlines and captions copies that link to the clipboard. The tooltips for links after headlines also show the section title, instead of the generic “Permalink to this headline”. Admonitions also include a link for easy referencing.
- 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.
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 html_theme in the Sphinx configuration file conf.py:
html_theme = "sphinxawesome_theme"
Read the full usage guide 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.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 052300053fdee1814a59db412617fcb9571739b764c798bb40a6e97e0b50c07c |
|
MD5 | 87e0f3799d86660db967715ba0cc41fc |
|
BLAKE2b-256 | 3a357fe45e595371270714bc6650256bf44f24cc1045098758b37b5befdce6ee |
Hashes for sphinxawesome_theme-1.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d31e193a708fc603714efaa6160cf248e0d2cbeb14699908e5b41cee0391cec4 |
|
MD5 | 650019861369090bf0c5c52a13c8d381 |
|
BLAKE2b-256 | 286613e05da8ffeb813a767faa41d31afeb1198e59bb02d38ae04b0493290f93 |