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-Sphinx-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 flasky.
Release files for Flask-Sphinx-Themes 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| Flask-Sphinx-Themes-1.0.2.tar.gz | 9.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 22.4 kB
Release files / Flask-Sphinx-Themes-1.0.2.tar.gz
| Download URL | Flask-Sphinx-Themes-1.0.2.tar.gz |
|---|---|
| Size | 9.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
bb23d7dd1a8ad9f47315bcb0439373c7feb24bcb0a1f8c52bb075f06489bb285
|
|
BLAKE2b-256 checksum How to use checksums |
ae665e84bfe3168295c9c806d87eebf65f4cfc07d9c2d4f27d80e026c69046e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl
| Download URL | Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl |
|---|---|
| Size | 13.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
d00ac0c04947b8325e13be862ef604b60b71aae50e79e30b9df3560f3536cb8e
|
|
BLAKE2b-256 checksum How to use checksums |
903b1577501c2b41f7031308f81c5583fdeeca7476e8c1ac9e187ad4a6e1b136
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
