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 https://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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f07c0a30c8e8d2c1fb8cfb49830fc64e4da9abc1bf0a21368d3239d753899db4 |
|
MD5 | 2ad325f40edd48ef14b19aef7055afe2 |
|
BLAKE2b-256 | 2a56ceb591be6002c430f604277392707a43a726cb7ed696e5b22bbf54c19847 |
Hashes for sphinxawesome_theme-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b88a1a25b852d4f0a59d47e35c32c209c57fc1fb84bf23d2bc288bcdc5196613 |
|
MD5 | c3138a119e4c534e90667d710d4e8417 |
|
BLAKE2b-256 | 435c598ee14c4e05dcaceb41d4f9bd3fd74a72769a0cba10ed6e3667fef621b0 |