用于变更日志操作的sphinx扩展
releases的Python项目详细描述
什么是发布?
发行版是与python(2.7,3.4+)兼容的Sphinx (1.3+)扩展,旨在帮助您保持源代码管理友好,合并 友好的更改日志文件,将其转换为有用的、可读的HTML输出。
具体来说:
- 源格式(在sphinx树中保持为changelog.rst)是 与源代码管理配合良好的流式时间线只需要一个 每个更改的条目(即使是在多个发布行中存在的更改)。
- 输出(当您安装了扩展并运行sphinx构建时 命令)是一个传统的更改日志页,每个 发布;多个发布问题将自动复制到每个发布中。
- 默认情况下,功能和支持问题仅显示在功能下 版本和Bug仅显示在BugFix版本下。这可能是 在每个问题的基础上重写。
有关创建此工具的原因的一些背景信息可以在this blog post中找到。
有关更多文档,请参见http://releases.readthedocs.io。
注意
您可以通过pip install -egit+https://github.com/bitprophet/releases/#egg=releases安装开发版本。