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
To use the theme, set html_theme in the Sphinx configuration file conf.py:
html_theme = "sphinxawesome_theme"
Configuration
To show also entries in the navigation menu from toctree directives with the :hidden: option, add the following setting to the Sphinx configuration file conf.py.
html_theme_options = {"nav_include_hidden": True}
Including :hidden: in a toctree directive makes Sphinx include the documents, but not print the list of links to the documents on the current page. This is useful when navigation links are shown elsewhere, for example in a menu on the left side. The default is nav_include_hidden=False in order to be compatible with other themes.
Limitations
This theme is designed to be simple. Some features are not (or not yet) available.
Zero custom theme variables to modify styles.
API documentation has not been tested. Some styles are missing.
Not all docutils/Sphinx roles have styles. There are a lot of them.
Internationalization was neglected.
Documentation
Read the documentation and 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.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 012906bef64685d876444424ef7d092b167805b7d9778c5ba2aebed1aa510f22 |
|
MD5 | ddd1d103e8f769c0e747749408bbe11c |
|
BLAKE2b-256 | 6b2d6b31e9224c9b809c324dfded62fdc6d55ca6186415c5eb0c86f35f6152b6 |
Hashes for sphinxawesome_theme-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e600647ce42fda23d83d99af0c4444e7e2822f1f133cd5a55492d0d29490fe7b |
|
MD5 | 66f2345685970746028f33b2ff928859 |
|
BLAKE2b-256 | 68e2720daf24b6bf2d9a8fd02ecdeebbf05f6da14e32ec33e6fefa6b084d5adc |