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
-
Install the theme as a Python package:
pip install sphinxawesome-theme
For more information, see Install the theme.
-
Add
sphinxawesome_theme
as an HTML theme in your Sphinx configuration fileconf.py
:html_theme = "sphinxawesome_theme"
For more information, see Add your theme.
-
Recommended: add the bundled extension for more awesome code blocks:
# conf.py extensions += ["sphinxawesome_theme.highlighting"]
Features
With the Awesome Theme, you can build readable, functional, and beautiful documentation websites.
Awesome code blocks
-
Code block have a Copy button for copying the code.
-
If you load the bundled
sphinxawesome_theme.highlighting
, you can use these additional options in yourcode-block
directives:emphasize-added
. Highlight lines that should be addedemphasize-removed
. Highlight lines that should be removedemphasize-text: TEXT
. HighlightTEXT
in the code block
Better headerlinks
Clicking the link icon after headers or captions automatically copies the URL to the clipboard.
DocSearch
This theme supports the sphinx-docsearch
extension
to replace the built-in search with Algolia DocSearch.
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-5.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46cc6ab4f3198af73a5390662ad42bf9dfadfe77ad833b90c8e0295be7c1a6b8 |
|
MD5 | fab7449882ac9da0133045f91fc96619 |
|
BLAKE2b-256 | b52479d5057532944e24a1be7610835a7691dae8cb35e46b1d778e1444682541 |
Hashes for sphinxawesome_theme-5.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8b422e9ed42572adb19d3ba2f2b367c6e615dc68c0e01b7d94d9df8b749175b5 |
|
MD5 | 7b9af8f9825dbf74b47f1c53e81eb04b |
|
BLAKE2b-256 | 47fd32b41532a93728892c91717809c94aa75f66ef1410f2654e7dae29e1924a |