跳转到主要内容

基于Python 3文档主题,并添加了一些响应式增强的样式。

项目描述

docs

Documentation Status

tests

Travis-CI Build Status

demo

default, bare

package

PyPI Package latest release PyPI Package monthly downloads

基于Python 3文档主题,并添加了一些响应式增强的样式。

  • 自由软件: BSD许可证

安装

pip install sphinx_py3doc_enhanced_theme

在您的文档的 conf.py 中添加以下内容

import sphinx_py3doc_enhanced_theme
html_theme = "sphinx_py3doc_enhanced_theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]

定制

无额外样式

此主题有一些额外样式,例如不同的字体、标题的文本阴影、行内代码和代码块的略微不同的样式。

要获取Python 3文档的原生样式,请在您的 conf.py 中添加以下内容

html_theme_options = {
    'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
    'bodyfont': '"Lucida Grande",Arial,sans-serif',
    'headfont': '"Lucida Grande",Arial,sans-serif',
    'codefont': 'monospace,sans-serif',
    'linkcolor': '#0072AA',
    'visitedlinkcolor': '#6363bb',
    'extrastyling': False,
}
pygments_style = 'friendly'

自定义favicon

要自定义favicon,请在您的 conf.py 附近创建一个 theme 目录,并在其中添加此 theme.conf 文件

[theme]
inherit = sphinx_py3doc_enhanced_theme

然后在 static 目录中创建一个 favicon.png 文件。

然后编辑您的 conf.py 以具有以下内容

import sphinx_py3doc_enhanced_theme
html_theme = "theme"
html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path(), "."]

最终的文件结构应如下所示

docs
├── conf.py
└── theme
    ├── static
    │   └── favicon.png
    └── theme.conf

一些额外的CSS

html_theme_options = {
    'appendcss': 'div.body code.descclassname { display: none }',
}

示例

更新日志

2.4.0 (2016-12-17)

  • 添加了使用Google Web Fonts的选项。由Marius P Isken在#11贡献。

2.3.2 (2015-12-24)

  • 修复了在没有页面内容时侧边栏大小回归的问题。侧边栏再次有自己的高度。

2.3.1 (2015-12-18)

  • 修复了滚动时侧边栏内容不移动的问题。

2.3.0 (2015-12-18)

  • 从多个地方移除了 !important 的使用。由 Matthias Geier 贡献,在 #10

2.2.4 (2015-10-23)

  • 移除了表格单元格中段落底部尴尬的填充。

  • 修复了“p”锚点(具有id和:target)的高亮显示。

2.2.3 (2015-09-13)

  • 修复了存在多个段落时参数描述的显示。第一段不应位于第二行。

2.2.2 (2015-09-12)

  • 修复了通过锚点位置哈希突出显示部分的问题。之前代码块会在左侧出现难看的横条。

2.2.1 (2015-08-21)

  • 修复了在窄模式下显示导航侧边栏时的定位(位于底部)。之前它覆盖了页脚。

2.2.0 (2015-08-19)

  • 添加了 appendcss 主题选项,以便快速自定义。

  • 添加了 path setuptools 入口点,因此不再需要在 conf.py 中设置 html_theme_path

2.1.1 (2015-07-11)

  • 在关闭 extrastyling 时移除引用链接的背景。

2.1.0 (2015-07-11)

  • 添加了新的主题选项 extrastyling,可用于获取原始 Python 3 文档样式(绿色代码块、灰色内联代码块、无文字阴影等)。

  • py.png 网站图标重命名为 favicon.png

  • 添加了一些用于自定义样式或使用自定义网站图标的示例。

2.0.2 (2015-07-08)

  • 使内联代码块加粗。

2.0.1 (2015-03-25)

  • 修复了包含默认.css(现在为 classic.css)的问题。

2.0.0 (2015-03-23)

  • 使用 HTML5 doctype 并强制 IE 进入 Edge 模式。

  • 添加了一个嵌入式标志,用于移除 JS(用于构建 CHM 文档)。

  • 继承正确的主题(在 Sphinx 1.3 中默认名称已更改)。

1.2.0 (2015-02-24)

  • 不小心发布了另一个版本。应该是 1.0.1 ... 真见鬼。

1.1.0 (2015-02-24)

  • 匹配最新 Sphinx 中的某些标记更改。

1.0.0 (2015-02-13)

  • 修复了 toctree 的深度参数(由 Georg Brandl 贡献)。

0.1.0 (2014-05-31)

  • 在 PyPI 上的首次发布。

项目详情


下载文件

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

源分布

sphinx-py3doc-enhanced-theme-2.4.0.tar.gz (42.1 kB 查看哈希值)

上传时间

构建分布

sphinx_py3doc_enhanced_theme-2.4.0-py2.py3-none-any.whl (36.2 kB 查看哈希值)

上传时间 Python 2 Python 3

由以下支持

AWSAWS云计算和安全赞助商DatadogDatadog监控FastlyFastlyCDNGoogleGoogle下载分析MicrosoftMicrosoftPSF赞助商PingdomPingdom监控SentrySentry错误日志StatusPageStatusPage状态页面