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.
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
File details
Details for the file documenteer-0.5.0a1.tar.gz.
File metadata
- Download URL: documenteer-0.5.0a1.tar.gz
- Upload date:
- Size: 74.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 478a6cfe9d3c3bc500d44541cc79a49233320c93004ccb151651f7bcd62e3dc9 |
|
| MD5 | 02bbb89710e3039d04c45e99306cf6c5 |
|
| BLAKE2b-256 | b2f3877bf69d2c65b3b1e57762a7c034c500468a1d79cfd9b911774c4816722d |
File details
Details for the file documenteer-0.5.0a1-py3-none-any.whl.
File metadata
- Download URL: documenteer-0.5.0a1-py3-none-any.whl
- Upload date:
- Size: 58.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.30.0 CPython/3.6.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a32bc88d0e4c2bcb333a168446999c0767eae2f29a0c5843545854fc9917be4a |
|
| MD5 | b6d466b1a2469f108a98945e3c3cd610 |
|
| BLAKE2b-256 | bc456cb12a8e0113c23c52916ad90fbd1d0e695e24bf9e4e93f216c4e8b5058f |
