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 Distributions
Hashes for documenteer-0.2.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b9be01f5b46226760424620e1dcaaf31fc33f983dab932beb8eed6c1d2c0c336 |
|
MD5 | c3de717d8a2cba66bdce1d0c9df706e7 |
|
BLAKE2b-256 | 16b80d786c18c4dd753f3d93f3250789ff5ea08060364f640c8937b1b7c2cfa1 |
Hashes for documenteer-0.2.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 067cc5fbf9e850fe4dc1ea457367feb550d4639c00c95b9db650d8e8880f7f81 |
|
MD5 | 865eb0a67ab03e2d1d1241a44e6e16c8 |
|
BLAKE2b-256 | 8500789da577c017252c8c8ac1966e6de67be2c192db981df14ee2310f64dca2 |