Sphinx themes for Flask and related projects.
Project description
This repository contains Sphinx themes for Flask and Flask related projects. To use this theme in your Sphinx documentation:
Install the package using pip: pip install Flask-Spinx-Themes
Add this to conf.py:
html_theme = 'flask'
Themes
The following themes exist for html_theme.
flask |
The standard Flask documentation theme for large projects |
flask_small |
Small single page theme. Intended to be used by very small addon libraries for Flask. |
Options
The following options can be set with html_theme_options.
index_logo |
Filename of a picture in _static to be used as replacement for the h1 in the index.rst file. Default unset. |
index_logo_height |
Height of the index logo. Default 120px. |
touch_icon |
Filename of a picture in _static to be use as the app icon on Apple devices. Default unset. |
github_fork |
Repository name on GitHub for the “Fork Me” badge. Default unset. |
github_ribbon_color |
Color for the “Fork Me” badge. Default darkblue_121621. |
Pygments Style
The theme automatically sets pygments_style to the provided style. Make sure you remove any override from conf.py or set it to flask_sphinx_themes.pygments.FlaskyStyle.
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 Flask-Sphinx-Themes-1.0.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a83eebca95fc5b8adbae4e65926961912edd52a1b6a422c0301a750d1ae31747 |
|
MD5 | abe1b4124bd3fd41fb8634545d5c6415 |
|
BLAKE2b-256 | b694bcf784389f89e3cfb398fc9d313bba7ef472a7d0f8bc19a2683a650d4a13 |
Hashes for Flask_Sphinx_Themes-1.0.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3a5d94f4a28044641153c9fd4823c2d93f2beecc69127f7be736e9d2e29e1a05 |
|
MD5 | b5b76dc6eabf4a9f6ea039169dd375b1 |
|
BLAKE2b-256 | e04cee0387bbbd2b390403e5e8f89fc8dffe0734ed4b93f2851cab04a2bd1210 |