sphinxcontrib-dashbuilder 0.1.0

功能

已实现

• 为dash API浏览器生成“文档集”。

尚未实现

• 使用Sphinx i18n翻译文档的关键词索引。

• 禁用侧边栏

• 支持目录表 http://kapeli.com/docsets#tableofcontents

安装

$ pip install sphinxcontrib-dashbuilder

如果您想使用未发布版本，可以从仓库安装

$ pip install -e hg+https://bitbucket.org/shimizukawa/sphinxcontrib-dashbuilder

配置

conf.py配置值

dash_name:

(可选) docset的显式名称。默认与项目相同。

dash_icon_file:

(可选) docset图标的PNG文件路径。

dash_translator_class:

(可选) 一个包含Dash翻译器类的完全限定名称的字符串，即Sphinx的DashTranslator的子类，用于将文档树转换为Dash的HTML。默认为None（使用内置的翻译器）。

conf.py示例

extensions = ['sphinxcontrib.dashbuilder']

dash_name = 'Python_3'
dash_icon_file = '_static/python.png'

运行

run

$ sphinx-build -b dash [source] [outdir]

您将在“_build/dash/”目录下获得dash文档集。