跳转到主要内容

kennethreitz/kr-sphinx-themes 的第三方包。

项目描述

这是Kenneth Reitz的 krTheme 的第三方包。您不再需要将主题文件复制到VCS或将它注册为子模块。

安装

pip install sphinx-kr-theme

当然,一般的用法是将它放入您的 docs/requirements.txt 中,然后它将被构建系统(如 ReadTheDocs)找到并安装。

使用

在您的 conf.py

import sphinx_kr_theme

html_theme = 'kr'  # or 'kr_basic'
html_theme_path = [sphinx_kr_theme.get_html_theme_path()]

在Sphinx >= 1.2中,您只需要设置主题名称

html_theme = 'kr_basic'

发布

0.2.0

kr_basic 主题添加了新选项。

现在您可以自定义“在GitHub上Fork我”横幅图像的URL和大小。

html_theme_options = {
    'github_fork': 'tonyseek/sphinx-kr-theme',
    'github_fork_ribbon': 'http://aral.github.com/fork-me-on-github-retina-ribbons/right-graphite@2x.png',
    'github_fork_ribbon_width': '149px',
    'github_fork_ribbon_height': '149px',
}

索引标志的大小也可以自定义。

html_theme_options = {
    'index_logo': 'logo@2x.png',
    'index_logo_width': '180px',
    'index_logo_height': '50px',
}

这些选项对于在文档中包含视网膜友好型图像很有用。

0.1.0

使用git-subtree包含原始存储库(Kenneth Reitz的存储库)并将其上传到PyPI。

项目详情


下载文件

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

源代码分发

sphinx-kr-theme-0.2.1.tar.gz (9.7 kB 查看哈希值)

上传时间: 源代码

构建分发

sphinx_kr_theme-0.2.1-py2.py3-none-any.whl (12.6 kB 查看哈希值)

上传时间: Python 2 Python 3

支持者