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.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87c8d8421ea5a08bc49fe389002bc7a254a1e0bcdf2968c34aaf1ab4081d8fbf |
|
MD5 | bcab7c0e5e529d685d6218581b500812 |
|
BLAKE2b-256 | b7f95034f67bd3df092457445be6c96c6627411e3d86d7658418af9a3d021899 |
Hashes for documenteer-0.2.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7b036af1b91bcaa68c67da0c9918da5e419b74ff413cbe666e657e14ce1432d |
|
MD5 | 6d23a76cbe47f07e3f06d33b02078c88 |
|
BLAKE2b-256 | a444f2c80dbe7bf63e4c3bc6a33d2c6fcba8b7386bfd9bacb981cdc47bf9e1a8 |