An awesome theme for the Sphinx documentation generator
Project description
Sphinx awesome theme
This is an awesome theme and a set of extensions for the Sphinx documentation generator. Using this theme and extension, you can change the look of your documentation website and add a number of useful improvements. See the theme in action at sphinxawesome.xyz.
Getting started
You can install the awesome theme from the Python package index and modify the Sphinx
configuration file conf.py
.
To get started using this theme, follow these steps:
-
Install the theme as a Python package:
pip install sphinxawesome-theme
See How to install the theme for more information.
-
Add the
html_theme
configuration option to the Sphinx configuration fileconf.py
:html_theme = "sphinxawesome_theme"
See How to use the theme for more information.
Features
This theme is designed with readability and usability in mind. The theme includes several extensions that enhance the usability:
-
Awesome code blocks
- Code blocks have a header section, displaying the optional caption, as well as the programming language used for syntax highlighting
- The code block headers contain a Copy button, allowing you to copy code snippets to the clipboard.
- The theme adds two new options to Sphinx's
code-block
directive:emphasize-added
andemphasize-removed
, for highlighting changes within other highlighted code.
-
Awesome 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. -
Awesome user experience improvements. These small features make the theme more usable:
-
Better keyboard navigation:
- Use the
Tab
key to navigate through all sections on the page - Use the Skip to Content link to bypass the navigation links
- Use the
/
key (forward Slash) to start a search
- Use the
-
Better "permalink" mechanism:
- Hovering over an element with a permalink reveals a Link icon
- Selecting the Link icon copies the link to the clipboard
- Notes, warnings and other admonitions have permalinks by default
-
Collapsible elements:
- Nested navigation links---all pages are reachable from all other pages
- Code definitions---code object definitions (functions, classes, modules, etc.), for example, obtained via the
sphinx.ext.autodoc
extension.
-
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-2.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8449d1107c3699ebff9b2d350df2434ff3cc03ff21f34affb24b2e485580ff5e |
|
MD5 | a8ddb38e155ff01e121bcbd71cf277a6 |
|
BLAKE2b-256 | c0a2adcfd793f411de1fbda9ed8c77653ebf5b252c96ab7e2c05807e489ac475 |
Hashes for sphinxawesome_theme-2.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b8489eadc243cf9fbed94e807de80e69e42b388a4943a29c334e4694d94e1a3 |
|
MD5 | 04f8d65b62555fbfaca46ba80c5222b8 |
|
BLAKE2b-256 | 2946bda1d71436554089c9c1a5d479bd79f3b8657d7f84ad54bf76601c2c7be3 |