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.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 836f88d04a27154196d7b3f2bfdafb96af177ff61724d429676fa8c1ee84c514 |
|
MD5 | 9c863da61ab3fd0a83b938309aa33ce8 |
|
BLAKE2b-256 | 4daf7e6fc8afc43fba113d2297f57759bf8e18b786df4660c843d923b34b0f4e |
Hashes for sphinxawesome_theme-5.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 83919c407e014638b680e1bf2d8f0eb57a4d8638e913b901167a937b56f91496 |
|
MD5 | 8bd6682e3d06496b353698902deab0bd |
|
BLAKE2b-256 | 035590295d38d5a7f93fa22eed83745d43c07f792a99d4773de51fce4e856b4c |