doctr-versions-menu 0.3.0

安装

要安装最新发布的doctr-versions-menu，请运行：

pip install doctr-versions-menu

或者，要从Github安装doctr-versions-menu的最新开发版本：

doctr-versions-menu包也可以通过conda安装，使用 conda-forge频道。参见instructions in the Doctr Versions Menu Feedstock。在

实际上，您可能只需要安装doctr-versions-menu 用于生成和部署文档的Travis上的包；或者，例如。， 在本地tox环境中，用于在 发展。在

用法

在文档中显示版本菜单需要两个步骤：

1. 将'doctr_versions_menu'添加到Sphinx conf.py中的扩展列表中。在

   这会将javascript添加到您的呈现文档中，该文档根据versions.json文件中的信息显示动态版本菜单，该文件希望在gh-pages分支的根目录中找到该文件。在

   在

2. 调用doctr-versions-menu命令作为doctr deploy（在.travis.yml）中的一部分。在

   例如

   doctr deploy --command=doctr-versions-menu --no-require-master --build-tags "$DEPLOY_DIR"

   这将导致在gh-pages分支的根中执行doctr-versions-menu。该脚本检查存在于其中的文件夹，并生成步骤1所依赖的versions.json文件。在

   在

有关详细信息，请参见步骤1和步骤2的full documentation。但是，对于遵循常规最佳实践的项目，您不需要在上述两个步骤之外进行任何自定义。在

示例

以下项目使用doctr-versions-menu：

• Krotov

0.3.0（2020-08-03）

• 添加了：--no-downloads-file选项，downloads_file = False在配置中。（#4，感谢Tyler Pennebaker）
• 修正：gh-pages分支上的versions.py未提交（#5）
• 修正：与任何pyparsing版本>= 2.0.2（#8，感谢Hugo Slepicka）的兼容性
• 添加：现在可以通过环境变量配置doctr-versions-menu可执行文件。这允许在源分支上保留配置，.travis.yml文件（#6，多亏了Tyler Pennebaker）
• Doctr版本菜单包现在可以通过conda安装（多亏了Hugo Slepicka）

0.2.0（2020-03-14）

• 添加了：--versions选项，用于自定义哪些文件夹出现在“版本”菜单中以及以何种顺序出现。在
• 添加了：--label选项，用于自定义出现在“版本”菜单中的标签
• 添加了：--warning选项，用于自定义在哪些文件夹上显示特定的警告
• 添加了：--latest选项，用于配置哪个文件夹是“最新稳定版本”
• 添加：将脚本versions.py写入gh-pages分支（--write-versions-py选项）的根目录
• 更改：未发布和预发布版本现在默认显示不同的警告
• 更改：index.html模板现在使用完整的version_data呈现
• 更改：开发/预发布版本现在在版本菜单中默认有“dev”后缀
• 更改：版本菜单现在使用默认情况下，与读取文档的版本顺序相同：文件夹按从最新到最新的顺序排列。在
• 已更改：versions.json
• 删除：--default-branch选项。它被新的--latest选项和index.html的增强模板呈现所取代
• 删除：--suffix-unreleased选项。现在可以通过--label选项来实现

这是一个破坏向后兼容性的主要版本。在

特别是，由于versions.json中的更改，当从旧版本升级时 可能需要替换现有的doctr-versions-menu.js文件 项目的gh-pages分支中的文件夹。在

0.1.0（2020-01-11）

• 初次发行