Skip to main content

Tools for LSST DM documentation projects

Project description

https://img.shields.io/pypi/v/documenteer.svg?style=flat-square https://img.shields.io/pypi/l/documenteer.svg?style=flat-square https://img.shields.io/pypi/wheel/documenteer.svg?style=flat-square https://img.shields.io/pypi/pyversions/documenteer.svg?style=flat-square

Documentation tools for LSST Data Management projects, including Sphinx extensions.

Installation

pip install documenteer

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
pip install -r requirements.txt

To make a release:

  1. Update CHANGELOG.rst.

  2. Increment version in setup.py.

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

  4. Push: git push --tags

Travis should handle the PyPI deployment.

License and info

Copyright 2015-2017 Association of Universities for Research in Astronomy, Inc.

MIT licensed. See LICENSE and COPYRIGHT <./COPYRIGHT>.

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.1.11.tar.gz (11.9 kB view details)

Uploaded Source

Built Distributions

documenteer-0.1.11-py3-none-any.whl (18.6 kB view details)

Uploaded Python 3

documenteer-0.1.11-py2-none-any.whl (18.6 kB view details)

Uploaded Python 2

File details

Details for the file documenteer-0.1.11.tar.gz.

File metadata

File hashes

Hashes for documenteer-0.1.11.tar.gz
Algorithm Hash digest
SHA256 8d41dc4c85c5e614e56d417b71fbb216071982c9b2666eadf3a4029c86210c66
MD5 3433a54d2223547ff69b25a881d5bc2d
BLAKE2b-256 8de09fdda137f9a2743d68f04d9994b8015881a6efedacd99c058529111c35a7

See more details on using hashes here.

File details

Details for the file documenteer-0.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for documenteer-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 ecb3e32394258bd9a091e04ddd59be6efa67c51889c5e0b4970c8e4ed2222b94
MD5 6398b5f41a1a9ae90a5019016f69b6cf
BLAKE2b-256 42cf7daab910ff7a9853f9d4f67952bf27d2bdbf8643fd9a3cbd5b2bac0be6d4

See more details on using hashes here.

File details

Details for the file documenteer-0.1.11-py2-none-any.whl.

File metadata

File hashes

Hashes for documenteer-0.1.11-py2-none-any.whl
Algorithm Hash digest
SHA256 5553e6327e5275e1dfb99200778b7364605b4ecb69cb0fc7550a9769b67433d3
MD5 b175c45d5347e0f964de7716eb4d0cab
BLAKE2b-256 48dc71f58ed41a27a93c44fd5a4137e62e446bd1a2dbeda4fb189d32ce114127

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