A simple theme for a Sphinx documentation
Project description
This is a simple but awesome theme for the Sphinx documentation generator.
Installation
Install the theme as a Python package:
pip install sphinxawesome-theme
Usage
To use the theme, set html_theme in the Sphinx configuration file conf.py:
html_theme = "sphinxawesome_theme"
To include all entries in the navigation menu, add the following setting to the Sphinx configuration file conf.py.
html_theme_options = {"nav_include_hidden": True}
If you set the option :hidden: to a toctree directive, the content will be included, but the list of links to the documents will not be written on the page itself. This can be useful when navigation links are shown elsewhere.
The Sphinx awesome theme shows a navigation menu on the left side of all pages, so having the links shown in the content area is not necessary. In order allow an easy transition from other Sphinx themes, the default is nav_include_hidden = False.
To make best use of this theme, include the :hidden: option to all ..toctree directives and set nav_include_hidden = True.
Demo
See how the theme looks on the demo page.
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-1.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7fdf06f1c2572e1995f63c22598538b3061382ca78bd3b25e21662d158ff392c |
|
MD5 | dff7eadbe37b3ddf3ae3365feee02d98 |
|
BLAKE2b-256 | cf709b5ed9f0436387ef5746e77a7a0e08917ed686b0f0292b277911585a6834 |
Hashes for sphinxawesome_theme-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65e960306be1320337b34b77514533cbcca50954c7c9a4051e35cfa8bf66cf2d |
|
MD5 | 45c31241d4290c08df846d1a28011883 |
|
BLAKE2b-256 | 794299a3150b789ad3b9cd7a0d252092227b39788c220aa27b7c8b3cdb160935 |