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.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
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.0.0rc1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2225b7391572086fa455ffeffa275aae53804a5e7e1de50235f6a51f9584209 |
|
MD5 | 04a7e681ba365175c41a05d1b78accbd |
|
BLAKE2b-256 | ff5fa59719670c52554317a68cf5cdbb5b8ec73c5ec43e7bd5df3b5d84c73c1f |
Hashes for sphinxawesome_theme-5.0.0rc1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 435038ac307184586738e441fc9adca6d148b30de78188efc6219ba182046032 |
|
MD5 | d355aa78cf3cb1c9d028c62c0c071390 |
|
BLAKE2b-256 | 623becefcdbd7a37154ee876bb7ba3d78c6eda565a6d1ccc06039c4db935eccf |