90beceeb7b
Rename the "doc" folder to "docs" to be consistent with the tox env name. RTD also seems to expect "docs" as its first choice, even though it will discover "doc" as well.
krTheme Sphinx Style
This repository contains sphinx styles Kenneth Reitz uses in most of his projects. It is a drivative of Mitsuhiko's themes for Flask and Flask related projects. To use this style in your Sphinx documentation, follow this guide:
put this folder as _themes into your docs folder. Alternatively you can also use git submodules to check out the contents there.
add this to your conf.py: :
sys.path.append(os.path.abspath('_themes')) html_theme_path = ['_themes'] html_theme = 'kr'
The following themes exist:
- kr
-
the standard flask documentation theme for large projects
- kr_small
-
small one-page theme. Intended to be used by very small addon libraries.