跳转到主要内容

为Flask及相关项目提供Sphinx主题。

项目描述

此存储库包含为Flask及其相关项目提供的Sphinx主题。要在您的Sphinx文档中使用此主题

  1. 使用pip安装包:pip install Flask-Sphinx-Themes

  2. 将以下内容添加到 conf.py

    html_theme = 'flask'

主题

以下主题可用于 html_theme

flask

大型项目的标准Flask文档主题

flask_small

小型单页主题。适用于Flask的非常小的附加库。

选项

以下选项可以使用 html_theme_options 设置。

index_logo

_static 中用作 index.rst 文件中 h1 替换的图片文件名。默认未设置。

index_logo_height

索引图标的宽度。默认120px

touch_icon

_static 中用作苹果设备上应用程序图标的图片文件名。默认未设置。

github_fork

用于“Fork Me”徽标的GitHub存储库名称。默认未设置。

github_ribbon_color

“Fork Me”徽标的颜色。默认深蓝色_121621。

Pygments样式

主题会自动将 pygments_style 设置为提供的样式。请确保从 conf.py 中移除任何覆盖设置,或将它设置为 flasky

项目详情


下载文件

下载适合您平台的文件。如果您不确定选择哪个,请了解有关 安装包 的更多信息。

源代码分发

Flask-Sphinx-Themes-1.0.2.tar.gz (9.1 kB 查看哈希值)

上传时间 源代码

构建分发

Flask_Sphinx_Themes-1.0.2-py2.py3-none-any.whl (13.4 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下组织支持