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.
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.
-
You can use these additional options in
code-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.3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0629d38b80aefc279b1186c53a7a6faf21e721b5b2ecda14f488ca1074e2631f |
|
MD5 | d48bcb0673f6c305a5076662bcaa3ff7 |
|
BLAKE2b-256 | 45586f3e05f77c881e1356d73fc1d99561efe1795671bd56e7fb47c63a32cc1f |
Hashes for sphinxawesome_theme-5.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f2bb6b6ab8fa11db1ded5590106eb557351d6a6c36adea7ebd4e0f4bc96945d |
|
MD5 | 09488655235bbf3e27227bfd7070ac75 |
|
BLAKE2b-256 | 9be9ca6a7178677bb171c8fd7f9eab726c00182168d38a79d2a58e7678590227 |