Metadata-Version: 2.1
Name: Flask-Sphinx-Themes
Version: 1.0.2.dev20220113
Summary: Sphinx themes for Flask and related projects.
Home-page: https://github.com/pallets/flask-sphinx-themes
Author: Armin Ronacher
Author-email: armin@ronacher.eu
Maintainer: David Lord
Maintainer-email: davidism@gmail.com
License: BSD
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Sphinx
Classifier: Framework :: Sphinx :: Theme
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Software Development :: Documentation
License-File: LICENSE

Flask Sphinx Themes
===================

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``:

   .. code-block:: python

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


