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 relatedprojects. To use this theme in your Sphinx documentation:
Install the package using pip:
pip install Flask-Sphinx-ThemesAdd this to
conf.py:html_theme = 'flask'
Themes
The following themes exist for html_theme.
| flask | The standard Flask documentation theme forlarge projects |
| flask_small | Small single page theme. Intended to be usedby 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 usedas replacement for the h1 in theindex.rst file.Default unset. |
| index_logo_height | Height of the index logo.Default 120px. |
| touch_icon | Filename of a picture in _static to be useas 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 toflasky.
-
Sphinx 是由 Georg Brandl 编写的工具，可轻松为 Python 项目（或由多个 reStructuredText 源组成的其他文档）创建智能且美观的文档。它最初是为新的 Python 文档创建的，具有用于Python项目文档的出色功能，但同时也支持C / C ++，并且计划了更多的语言。 Sphinx使用reStructuredText作为标记语言，它的许多优势来自reStruc
-
Since many projects will need special features in their documentation, Sphinx is designed to be extensible on several levels. This is what you can do in an extension: First, you can add new builders t
-
New in version 1.0. What is a Domain? Originally, Sphinx was conceived for a single project, the documentation of the Python language. Shortly afterwards, it was made available for everyone as a docum
-
This is a list of Frequently Asked Questions about Sphinx. Feel free to suggest new entries! How do I... ... create PDF files without LaTeX? You can use rst2pdf version 0.12 or greater which comes wit
-
New in version 1.0. What is a Domain? Originally, Sphinx was conceived for a single project, the documentation of the Python language. Shortly afterwards, it was made available for everyone as a docum
-
CMU Sphinx 是一个语音识别系统，包含一个 libsphinx2 库和一些小的实例。