Skip to main content

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:

  1. Install the package using pip: pip install Flask-Sphinx-Themes

  2. 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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Flask-Sphinx-Themes-1.0.2.tar.gz (9.1 kB view details)

Uploaded Source

Built Distribution

Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl (13.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Flask-Sphinx-Themes-1.0.2.tar.gz.

File metadata

File hashes

Hashes for Flask-Sphinx-Themes-1.0.2.tar.gz
Algorithm Hash digest
SHA256 bb23d7dd1a8ad9f47315bcb0439373c7feb24bcb0a1f8c52bb075f06489bb285
MD5 333813fbba8e4956e69ddd70e6b9fbb3
BLAKE2b-256 ae665e84bfe3168295c9c806d87eebf65f4cfc07d9c2d4f27d80e026c69046e6

See more details on using hashes here.

File details

Details for the file Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 d00ac0c04947b8325e13be862ef604b60b71aae50e79e30b9df3560f3536cb8e
MD5 375c5744ddd3dff18aa459f33585e2fe
BLAKE2b-256 903b1577501c2b41f7031308f81c5583fdeeca7476e8c1ac9e187ad4a6e1b136

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page