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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 91d4df71c55f7e6a4a617efe61f2267339ff63c56f39bec8b7b192b504f118c4 |
|
MD5 | 35330374519ffb281e93eccf77fcf258 |
|
BLAKE2b-256 | 629bba386020a6ec18637009c29a89eaf321325df08d212d637658cdcb3b1257 |
Hashes for sphinxawesome_theme-5.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d34f276f9785138cf9bb60d3a7294e5bdb93118989e8965ed0d9fee691d7702a |
|
MD5 | 854423391d6484ca47d5c45fe8623ef0 |
|
BLAKE2b-256 | f3467d02503d3ffdaea37c74061bf3750902a729b35a3e9addb337ab096a4f80 |