documenteer

Documentation tools for LSST Data Management projects, including Sphinx extensions.

Installation

pip install documenteer

Development

Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install:

.. code-block:: bash

git clone https://github.com/lsst-sqre/documenteer.git pip install -r requirements.txt

To make a release:

1. Update the :file:`CHANGELOG.rst`.

2. Increment version in :file:`setup.py`.

3. Tag: git tag -s -m "Version X.Y.Z" vX.Y.Z

4. Build:

   rm -R dist
   python setup.py sdist bdist_wheel

5. Upload:

   twine upload dist/*
   git push --tags

License

MIT Licensed. See :file:`LICENSE` and :file:`COPYRIGHT`.