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
To use this theme in your project,
install it via pip
and add it to your Sphinx configuration.
-
Install the theme as a Python package:
pip install sphinxawesome-theme
For more information, see How to install the theme.
-
Add
sphinxawesome_theme
as an extension and HTML theme in your Sphinx configuration fileconf.py
:html_theme = "sphinxawesome_theme" extensions = ["sphinxawesome_theme"]
For more information, see How to load the theme for more information.
Features
With the Awesome Theme, you can build readable, functional, and beautiful documentation websites. These features make your documentation awesome:
Awesome code blocks
Code blocks show the language of the code in a header.
Each code block has a Copy button for easy copying.
This theme enhances Sphinx's code-block
directive with these options:
emphasize-added
. Highlight lines that should be added to codeemphasize-removed
. Highlight lines that should be removed from the codeemphasize-text: TEXT
. HighlightTEXT
in the code block to emphasize placeholder text the user should replace.
Collapsible elements
Nested navigation links allow you to reach all pages from all other pages. You can make code object definitions like methods, classes, or modules collapsible as well.
Better headerlinks
Clicking the link icon after headers or captions automatically copies the URL to the clipboard.
DocSearch
If you have an Algolia DocSearch account for your documentation, you can use DocSearch for a search-as-you-type experience with autocomplete. Algolia DocSearch is free for open source documentation projects.
Better keyboard navigation
Use the Tab
key to skip through all sections on the page.
Use the Space
key to expand or collapse items in the navigation menu or in code definitions.
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-4.0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c610bddd87b3f949109dd988a3735f238685843767e3859ba9895af23c54661f |
|
MD5 | 2a559e56b5de24335ddefda6a0f386f8 |
|
BLAKE2b-256 | 7375238ba733079bb68852bd4cfc398a2ed96bb0429f7119b83d713eac8083ab |
Hashes for sphinxawesome_theme-4.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 408e5ce49aaeccee4fd9e04728095de0a216fff945ce855238630642c12f3591 |
|
MD5 | c3d246c5db3f3d0e9661bed4228b1ea0 |
|
BLAKE2b-256 | 9388a76253409650ae49d0d0156d625a1f20d04134655d4b34c442ff6b588263 |