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.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d35f7de1398c122df9b3a7a749a1bbcc1ea6d584f44033ab4ffb0f7c1bb6cd7 |
|
MD5 | fbb333cfe137bf0da1a01e5013a279dc |
|
BLAKE2b-256 | 83b0360532837481d4d4c222e5eaf7ef412c706a38611d98a8ba7a56daae391b |
Hashes for documenteer-0.2.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e354c54522895c236a1fa3fb7bd51c8deca6949797b932d349e0154d14c06055 |
|
MD5 | ce06aa0d20b35e56b1c3481e0853d5cc |
|
BLAKE2b-256 | 567e02af06020d37d2a2392ecede6b8d94defa8847015d89a6d24d34efd90ed1 |