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.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 644a35e1360dc45316062dfced232b7386cbcfcf8e0c0a0f6fffd9bc47879149 |
|
MD5 | 768897cd6c3edb9bece5c5432cd2d8f1 |
|
BLAKE2b-256 | 974b519a0ecaa53b2b3f957936cea1f516d754947ab517622322720f3a87e789 |
Hashes for documenteer-0.2.5-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 073143204e8e95740ee4ac177da8c05e63f344123a503a292d79aa3e386db128 |
|
MD5 | 2d36bd354e43208f0f6a5df7cf450450 |
|
BLAKE2b-256 | bec60a8bae8dbd4171a5ea6115e5f9b9b12b85b09e6e9a0243c7f03bcae90a1e |