在读取文档时运行自定义步骤的黑客。
readthedocs-custom-steps的Python项目详细描述
读取Docs自定义步骤
在阅读文档的基础上生成文档时运行自定义步骤的hack。在
配置
# .readthedocs.yml version: 2 mkdocs: {} # tell readthedocs to use mkdocs python: version: 3.7 install: - requirements: requirements.txt # must contain "readthedocs-custom-steps"^{pr2}$
Important: This module should not be installed outside of a Read the Docs build environment. It will rename your Python executable and install a substitute. It does not currently provide an automated way to revert this change.
正在测试此包
要在与读取文档本身类似的环境中测试此包,可以运行make test
。
请注意,这需要Docker和一个名为pip-caches
的Docker卷。注意Make命令
应返回test/.readthedocs-custom-steps.yml
文件中定义的状态代码27
。在
发布过程
需要Shore。在
$ make bump TYPE=--minor
$ make publish
- 项目
标签: