docs/_themes/README

   1 Flask Sphinx Styles
   2 ===================
   3
   4 This repository contains sphinx styles for Flask and Flask related
   5 projects.  To use this style in your Sphinx documentation, follow
   6 this guide:
   7
   8 1. put this folder as _themes into your docs folder.  Alternatively
   9    you can also use git submodules to check out the contents there.
  10 2. add this to your conf.py:
  11
  12    sys.path.append(os.path.abspath('_themes'))
  13    html_theme_path = ['_themes']
  14    html_theme = 'flask'
  15
  16 The following themes exist:
  17
  18 - 'flask' - the standard flask documentation theme for large
  19   projects
  20 - 'flask_small' - small one-page theme.  Intended to be used by
  21   very small addon libraries for flask.
  22
  23 The following options exist for the flask_small theme:
  24
  25    [options]
  26    index_logo = ''              filename of a picture in _static
  27                                 to be used as replacement for the
  28                                 h1 in the index.rst file.
  29    index_logo_height = 120px    height of the index logo
  30    github_fork = ''             repository name on github for the
  31                                 "fork me" badge