sphinx扩展,允许构建自托管的版本化文档。
sphinxcontrib-versioning的Python项目详细描述
sphinx扩展,允许构建自托管的版本化文档。
- Linux和OS X上支持Python2.7、3.3、3.4和3.5。
- Windows支持Python2.7、3.3、3.4和3.5(32位和64位版本的Python)。
完整文档:https://robpol86.github.io/sphinxcontrib-versioning
快速启动
安装:
pip install sphinxcontrib-versioning
用法:
sphinx-versioning --help sphinx-versioning build --help sphinx-versioning push --help
更改日志
这个项目遵循Semantic Versioning。
2.2.1-2016年12月10日
- 已添加
- html_last_updated_fmt的时间值将是最后一个git提交(作者)日期。
- 固定的
2.2.0-2016年9月15日
2.1.4-2016年9月3日
- 固定的
- banner.css被conf.py覆盖:https://github.com/Robpol86/sphinxcontrib-versioning/issues/23
2.1.3-2016年8月24日
- 固定的
- 停止阻止用户重写layout.html。使用另一种方法插入横幅。
2.1.2-2016年8月24日
- 固定的
- 从push remote而不是origin克隆。如果html文件被推送到源代码以外的另一个repo,则不会 从源克隆是有意义的(以前的文件将不可用)。
2.1.1-2016年8月23日
- 已添加
- 命令行选项:--push-remote
- 固定的
- 将生成的文档推送到远程时,将所有远程文件从原始repo复制到临时克隆的repo。 携带所有远程url,以防用户为push-vs-fetch定义不同的url。
2.1.0-2016年8月22日
- 已添加
- 在旧/开发版本中启用警告横幅的选项。类似于Jinja2的文档。
- 命令行选项:--banner-greatest-tag--banner-recent-tag--show-banner--banner-main-ref
- jinja2上下文函数:vhasdoc()vpathto()
- jinja2上下文变量:scv_show_bannerscv_banner_greatest_tagscv_banner_main_ref_is_branchscv_banner_main_ref_is_tagscv_banner_main_versionscv_banner_recent_tag
- 已更改
- 根引用也将像其他版本一样构建在自己的目录中。所有指向根ref的url都将指向 而不是根目录。更多信息:https://github.com/Robpol86/sphinxcontrib-versioning/issues/15
- 将jinja2上下文变量scv_is_root_ref重命名为scv_is_root。
- 固定的
- 删除
- jinja2上下文变量:scv_root_ref_is_branchscv_root_ref_is_tag
2.0.0-2016年8月15日
- 已添加
- --git-root命令行选项。
- --whitelist-branches和--whitelist-tags命令行选项。
- --local-conf和--no-local-conf命令行选项。
- 从conf.py文件和命令行参数加载设置,而不仅仅是后者。
- 已更改
- 将命令行选项--prioritize重命名为--priority。
- 将命令行选项-S重命名为-s。
- --chdir、--no-colors和--verbose必须在生成/推送之前和之后指定。
- --sort不再使用逗号分隔的字符串。现在指定多次(比如--grm-exclude)。
- 将--sortvalue“chrono”重命名为“time”。
- 重新排序的位置命令行参数。在目标参数之前移动了REL_SOURCE。
- 将命令行选项-C重命名为-N,以与sphinx构建保持一致。
- 固定的
- 向scversioning公开sphinx构建详细信息。指定一个-v使scversioning变得冗长,并指定两个或更多 使狮身人面像成为动词奥斯。
- 使用--no-colors还会关闭sphinx构建的颜色。
- https://github.com/Robpol86/sphinxcontrib-versioning/issues/16
1.1.0-2016年8月7日
- 已添加
- 公开jinja2上下文变量:scv_is_branchscv_is_root_refscv_is_tagscv_root_ref_is_branchscv_root_ref_is_tagscv_is_greatest_tagscv_is_recent_branchscv_is_recent_refscv_is_recent_tag
- 已更改
版本链接指向当前页面的那个版本,如果它存在的话。 - 固定的
1.0.1-2016-08-02
1.0.0-2016年7月23日
- 初次发布。