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 verdocUsage
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 push1 maintainer
Metadata
1 maintainer
Release files for verdoc 1.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| verdoc-1.0.2.tar.gz | 18.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| verdoc-1.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 32.3 kB
Release files / verdoc-1.0.2.tar.gz
| Download URL | verdoc-1.0.2.tar.gz |
|---|---|
| Size | 18.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a2c9c9a1074643aabab6e9c0d2ef0aca94424273a2c3cf69b8f3f5ec4f89356
|
|
BLAKE2b-256 checksum How to use checksums |
6c2e22e1212d7ac27a83476ac65d7d7237740903b539e67c7ed2d47b758f7be2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10
|
Release files / verdoc-1.0.2-py3-none-any.whl
| Download URL | verdoc-1.0.2-py3-none-any.whl |
|---|---|
| Size | 14.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
43a83ae0708f1674d2adaf33f3e3e08e361c31df858af5719d9a369fd452bc43
|
|
BLAKE2b-256 checksum How to use checksums |
6ccf419472a597a6d5012705b559b231996c17529677324dfba1b538ce5c4836
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.7.10
|
Security for verdoc 1.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
