跳转到主要内容

从源控制部署引用。

项目描述

从源控制部署引用。

  • verdoc 检出 Git 标签/分支/提交等,并在临时克隆中运行

    tox -e verdoc -- "$outdir"
  • verdoc-index 创建一个 index.html 文件,该文件可重定向到您提供的任何URL。

默认支持 Git 和 tox,但 verdoc 旨在模块化且易于扩展。

安装

使用 pipx 安装 verdoc

pipx install verdoc

使用方法

有关详细使用说明,请参阅 文档

$ git checkout --orphan gh-pages
$ git rm -rf .
$ git tag -l
v1.0.0
v2.0.0
$ # Run `tox -e docs` instead of `tox -e verdoc`:
$ verdoc --build-opt env=docs v1.0.0 v2.0.0
INFO:verdoc:[v1.0.0] started
INFO:verdoc:[v2.0.0] started
INFO:verdoc:[v1.0.0] succeeded
INFO:verdoc:[v2.0.0] succeeded
$ git add v1.0.0/ v2.0.0/
$ git commit -m "Add built docs for v1.0.0 and v2.0.0"
$ verdoc-index v2.0.0
$ git add index.html
$ git commit -m "Create an index.html that redirects to v2.0.0"
$ git push

项目详情


下载文件

下载适用于您的平台文件。如果您不确定选择哪个,请了解有关 安装软件包 的更多信息。

源分布

verdoc-1.0.2.tar.gz (18.0 kB 查看哈希)

上传时间:

构建分布

verdoc-1.0.2-py3-none-any.whl (14.3 kB 查看哈希值)

上传时间 Python 3

由以下提供支持