sphinx-version-warning 1.1.2

它是如何工作的？

当访问启用此扩展的Read the Docs页面时，会向Read the Docs服务器发送一个AJAX请求，以检索项目的所有活动版本。这些版本与我们正在读取的版本进行比较，如果它是一个旧版本，则会在页面顶部显示一个警告横幅。

示例

在Read the Docs上有一个实时示例

• 最新版本 不显示任何类型的警告横幅

• 0.0.1 版本显示针对此特定版本的定制消息

• 0.0.2 版本显示一个警告横幅，表示0.0.4版本可用（在编写此文档时）

• 0.0.4 版本不显示任何横幅，因为它是最新版本（在编写此文档时）

安装

只需在您的虚拟环境中运行此pip命令即可

pip install sphinx-version-warning

然后，在您的conf.py中，您必须在extensions列表中添加versionwarning.extension。应该是这样的

extensions = [
    'versionwarning.extension',
]

请记住配置您的 Sphinx 项目的 versionwarning_project_version 和 versionwarning_project_slug，因为这是使其正常工作的关键。

versionwarning_project_version = '0.0.1'
versionwarning_project_slug = 'sphinx-version-warning'

自定义

可以使用您的 Sphinx 项目的 conf.py 文件进行一些自定义。

versionwarning_admonition_type (字符串)

横幅的警告类型（警告、警告或注意）

versionwarning_default_message (字符串)

警告横幅的默认消息

versionwarning_messages (字典)

版本和其横幅消息之间的映射

versionwarning_message_placeholder (字符串)

要替换消息中版本号链接的文本

versionwarning_project_slug (字符串)

Read the Docs 下的项目缩略名（默认为 READTHEDOCS_PROJECT 环境变量）

versionwarning_project_version (字符串)

当前文档的版本缩略名（默认为 READTHEDOCS_VERSION 环境变量）

versionwarning_api_url (字符串)

检索此项目的所有版本的 API URL

versionwarning_banner_html (字符串)

用于显示横幅的 HTML 代码

versionwarning_banner_id_div (字符串)

用于作为横幅注入的 HTML 元素 ID

versionwarning_body_selector (字符串)

jQuery 选择器，用于在页面中找到 body 元素并将横幅 prepend

如何贡献？

欢迎提交拉取请求！

npm install
./node_modules/.bin/webpack

发布

1. 在 versionwarning/__init__.py 中增加版本号

2. 在 package.json 中增加版本号

3. 更新 CHANGELOG.rst

4. 更新 npm

   $ npm update

5. 编译资源

   $ npm install
   $ ./node_modules/.bin/webpack

6. 提交更改： git commit -m "发布 $NEW_VERSION"

7. 在 git 中标记发布： git tag $NEW_VERSION

8. 将标签推送到 GitHub： git push --tags origin

9. 将包上传到 PyPI

   $ rm -rf dist/
   $ python setup.py sdist bdist_wheel
   $ twine upload dist/*