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
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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0658f49ff185ab76e8eeca449dc5b8024d4d507cb6813d55674716c46deeb36 |
|
MD5 | dbcc1bf28bb1ccfe3b3bfbf39459265f |
|
BLAKE2b-256 | 5fdb2313af0d9cc5c2ecc2887d6933acd5102fd849185d20ad61e4e33718008a |
Hashes for sphinxawesome_theme-5.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 88a3d3cab6b06b7bde74e0e125129d5acac28e80e0999d23e125ac57541f7f84 |
|
MD5 | 3a70c6afc283ed32fef066e6d09311a7 |
|
BLAKE2b-256 | 6155a0485ae46cb305bc48cd742f520d95b32ca7bcee7200e01f006cc4bc8911 |