Tools for LSST DM documentation projects
Project description
Documenteer
Sphinx documentation tools for LSST Data Management projects.
Browse the lsst-doc-engineering GitHub topic for more LSST documentation engineering 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 ".[dev]"
To make a release:
Update CHANGELOG.rst.
Tag: git tag -s X.Y.Z -m "X.Y.Z"
Push: git push --tags
Use a PEP 440-compliant version identifiers.
Travis CI 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 Distribution
Hashes for documenteer-0.4.0a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6337452c5a7aa134b5dc7e9986ab75446857edc53682c4ad0d333ede6df3faad |
|
MD5 | 988a2bf95de38f1684838a182fb745f4 |
|
BLAKE2b-256 | d89ac699bcbb2b09001ff176c25db3ae3b87b569abab4faaf3ce8cc0ac15a6ad |