pallets / flask-sphinx-themes

Sphinx themes for Pallets projects

Flask Sphinx Themes

Modern Pallets themes have moved to https://github.com/pallets/pallets-sphinx-themes. The Flask theme has been updated an included there. This repository is no longer maintained.

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.

Sidebar Templates

The following sidebar templates can be included in html_sidebars.

relations.html

Show parent, previous, and next links.

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.

flask-sphinx-themes's Issues

Please make the side bar fixed

This way we don't have to scroll up every time...
This is especially trough to project with really long docs like flask, but it
also been an issue while reading the docs for click.

Simple add to flasky.css,

div.sphinxsidebarwrapper {
    padding: 18px 10px;
    position: fixed;
    word-wrap: break-word;
    width: 10%;

}

this makes it really nice to read.

If you want, I can make a PR.

Wrong name on pypi

On this page (https://pypi.python.org/pypi/Flask-Sphinx-Themes), it says pip install Flask-Spinx-Themes when it should be pip install Flask-Sphinx-Themes (note the missing 'h' in sphinx).

It's already been corrected in this repo (ea3cb2a), so I'm guessing that page just needs to be rebuilt/refreshed.

theme_github_fork for full theme?

It seems like theme_github_fork is only provided for the small version of the theme. Is there a particular reason this isn't provided for the full theme?