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.

Download files

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

Files for Flask-Sphinx-Themes, version 1.0.2
Filename, size File type Python version Upload date Hashes
Filename, size Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl (13.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size Flask-Sphinx-Themes-1.0.2.tar.gz (9.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page