Skip to main content

Tools for LSST DM documentation projects

Project description

PyPI MIT license Uses wheel For Python 2.7 and 3.5+

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:

  1. Update CHANGELOG.rst.

  2. Tag: git tag -s -m "X.Y.Z" vX.Y.Z

  3. 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

documenteer-0.3.0a4.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

documenteer-0.3.0a4-py3-none-any.whl (32.5 kB view details)

Uploaded Python 3

File details

Details for the file documenteer-0.3.0a4.tar.gz.

File metadata

File hashes

Hashes for documenteer-0.3.0a4.tar.gz
Algorithm Hash digest
SHA256 81cd044b0bef5f045d54c8449c754a5d6e4ce43b67ae10e31398431060f28154
MD5 cf8a28dae0e9c5530f3ca4f82864ab85
BLAKE2b-256 40eff1e37c3ae10b0667e65c9eaa2ed59d470c5b2badd5b8fc96e4fc0f76c82f

See more details on using hashes here.

File details

Details for the file documenteer-0.3.0a4-py3-none-any.whl.

File metadata

File hashes

Hashes for documenteer-0.3.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 bbe0eb99700554cc4b5066eb2fbd63d56b1b5d27ce1aaf641f65cc8a5b914ea6
MD5 0c086179829d0a34ead04b0bf42e4bf3
BLAKE2b-256 df3f18ab5540a51ece0c61977df7b3984e3fd3e14f07962dda80326e2a73a8cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page