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
To use this theme for your documentation, install it via pip
and add it to your
Sphinx configuration.
-
Install the theme as a Python package:
pip install sphinxawesome-theme
See How to install the theme for more information.
-
Set
html_theme
in the Sphinx configuration fileconf.py
:html_theme = "sphinxawesome_theme"
-
Add the theme as an extension in the Sphinx configuration file
conf.py
:extensions = ["sphinxawesome_theme"]
See How to load the theme for more information.
For more information about configuring the theme for your use case, see How to configure the theme.
Features
With the Awesome Theme, you can build readable, functional, and beautiful documentation websites. These features enhance the user experience:
Awesome code blocks
The code block shows the language of the code in a header.
Each code block has a Copy button for easy copying.
This theme enhances Sphinx's code-block
directive with:
emphasize-added
: highlight lines that should be added to codeemphasize-removed
: highlight lines that should be removed from the codeemphasize-text: TEXT
: highlightTEXT
in the code block to emphasize placeholder text the user should replace.
Collapsible elements
Nested navigation links allow you to reach all pages from all other pages. You can make code object definitions, like methods, classes, or modules, collapsible as well, to focus on one item at a time.
Better headerlinks
Clicking the link icon after a header or caption automatically copies the URL to the clipboard.
DocSearch
If you have an Algolia DocSearch account for your documentation (it's free for open source projects), you can use DocSearch for a search-as-you-type experience with autocomplete.
Better keyboard navigation
Use the Tab
key to quickly skip through all sections on the page.
Use the Space
key to expand or collapse items in the navigation menu or in code definitions.
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-3.3.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60932ca39911252bf1c3817f417bddfb5da13cb46e7a97a4bb6029af7196e4e9 |
|
MD5 | 97eaf7367450e21f8b2fd93de0280570 |
|
BLAKE2b-256 | c4bf105eca02753d3600e3ea2c8a185b861be625ca5fbd5c86a674f23a2419b5 |
Hashes for sphinxawesome_theme-3.3.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a04e7df4c65615d13ae8700296de215f8a177fa7dc70c1f8982247fe107020e |
|
MD5 | 94e08cb5dc02e8212f9a8bfc1e080a8c |
|
BLAKE2b-256 | 0bc457d9953a65c3724561e2609f6a38542b32fd06b6ab1e53faa522c34d0997 |