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.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 742a7253e955997544be799d3df4e05cb3de3b907ed86e574d7d73380cf02f30 |
|
MD5 | 32724e86b85cf1cdd6a7e37ccb85779d |
|
BLAKE2b-256 | 3ab6cd476dc1d38a4ab0c1d81ef193425a05b195984e22835f532b3ec5050972 |
Hashes for documenteer-0.2.1-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0af40a762c07040521d8133bd180a04f3cc36b62c0fe734026d861cee9e4a44 |
|
MD5 | 63887ad200ec11dece2fe691512b6ebe |
|
BLAKE2b-256 | 9e5759c8c106f7d9c143d6988118e4ad6f9c41ea0257e30944abf124b102a5fb |