Tools for LSST DM documentation projects
Project description
Documenteer
Sphinx documentation tools for LSST Data Management projects.
Installation
How you install Documenteer depends on the project you’re using it for:
For technical note projects: pip install documenteer[technote]
For the https://pipelines.lsst.io project: pip install documenteer[pipelines]
Development
Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install:
git clone https://github.com/lsst-sqre/documenteer.git cd documenteer pip install -e ".[technote,pipelines,dev]"
To make a release:
Update CHANGELOG.rst.
Tag: git tag -s -m "X.Y.Z" vX.Y.Z
Push: git push --tags
Travis handles the PyPI deployment.
License and info
Documenteer is a project by the Large Synoptic Survey Telescope.
MIT licensed. See LICENSE for details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for documenteer-0.3.0a3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | bcee271493e83b4106cb04a52e6f69412bdd49615e3ded3f80dd07f4a1c4c283 |
|
MD5 | 05106f573e05d752cc3faa694af7b52f |
|
BLAKE2b-256 | 18de9c7c1c7d5d2cbbcec6aee49f2c702c70f59484e10b94241df78915a8d9a0 |