klink 0.1.10

选项

以下是主题选项。它们应添加到您的conf.py文件中的html_theme_options中。

• github

  项目的github地址。格式为name/project（pmorissette/klink）。

• logo

  标志文件。假定在_static目录中。默认为logo.png。标志应为150x150。

• analytics_id

  您的Google Analytics id（通常以UA-开头）

IPython Notebook集成

使用klink辅助函数convert_notebooks()，所有笔记本都将转换为.rst，以便它们可以包含在文档中。这包括所有输出，包括图像。这是一种非常方便的创建Python文档的方法！

您只需在源目录（与您的 conf.py 文件相同的目录）中创建笔记本。然后，在您的 conf.py 中添加对 klink.convert_notebooks() 的调用。您还可以在工作簿中混合使用 Markdown 单元或 原始 NBConvert 单元。这些将被转换为 rst。

如果您使用原始 NBConvert 类型单元，请在开头添加一个空行。在 rst 转换中似乎存在一个错误，如果单元不是从空行开始的，您可能会遇到一些问题。

使用带有 rst 文本的内联 NBConvert 单元很方便，特别是如果您想链接到 Sphinx 文档的其他部分。

安装

假设您已经安装了 pip

$ pip install klink

就是这样。

用法

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

import klink

html_theme = 'klink'
html_theme_path = [klink.get_html_theme_path()]
html_theme_options = {
    'github': 'yourname/yourrepo',
    'analytics_id': 'UA-your-number-here',
    'logo': 'logo.png'
}

Klink 还附带一个有用的辅助函数，允许您将 IPython Notebook 集成到 .rst 文件中。它基本上将笔记本转换为 .rst 并将静态数据（图像等）复制到您的 _static 目录。

如果您想集成 IPython Notebook，请在您的 conf.py 中使用以下代码

klink.convert_notebooks()

转换完成后，您将有一个与您的每个笔记本同名 .rst 文件。

注意：请将您的笔记本放在文档的源目录中。

现在，您只需使用 include 命令将它们插入到您的文档中。

自定义

显然，有些人会想自定义主题。最简单的方法是将仓库克隆到您的 _themes 文件夹中（如果您的文档源目录中不存在，请创建它）。要更改样式，我建议直接编辑 LESS 文件。您还需要 lessc 来将 less 转换为 css。请参阅 Makefile 中的 css 命令示例。

您还可以探索使用 git subtree 的选项。这里有一个好的 入门教程。

您还需要更改您的 conf.py 文件。以下设置应该可以工作

html_theme = 'klink'
html_theme_path = ['_themes']
html_theme_options = {
    'github': 'yourname/yourrepo',
    'analytics_id': 'UA-your-number-here',
    'logo': 'logo.png'
}