Skip to main content

Deploy references from source control.

Project description

Deploy references from source control.

  • verdoc checks out Git tags/branches/commits/etc. in temporary clones and runs:

    tox -e verdoc -- "$outdir"
  • verdoc-index creates an index.html file that redirects to any URL you give it.

Only Git and tox are supported out of the box, but verdoc aims to be modular and easy to extend.

Installation

Use pipx to install verdoc.

pipx install verdoc

Usage

See the documentation for detailed usage instructions.

$ 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

verdoc-1.0.2.tar.gz (18.0 kB view hashes)

Uploaded source

Built Distribution

verdoc-1.0.2-py3-none-any.whl (14.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page