Metadata-Version: 2.1
Name: verdoc
Version: 1.0.2
Summary: Deploy references from source control.
Home-page: https://pypi.org/project/verdoc
Author: David Tucker
Author-email: david@tucker.name
License: LGPLv2+
Project-URL: Code, https://github.com/dmtucker/verdoc
Project-URL: Documentation, https://dmtucker.github.io/verdoc
Project-URL: Issues, https://github.com/dmtucker/verdoc/issues
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Intended Audience :: End Users/Desktop
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Development Status :: 4 - Beta
Requires-Python: >= 3.7
Description-Content-Type: text/x-rst
License-File: LICENSE

======
Verdoc
======

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 <https://pipxproject.github.io/pipx/>`__ to install ``verdoc``.

.. code:: sh

    pipx install verdoc

Usage
=====

See `the documentation <https://dmtucker.github.io/verdoc/>`__ for detailed usage instructions.

.. code:: sh

  $ 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


