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

Uploaded Source

Built Distributions

documenteer-0.2.4-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

documenteer-0.2.4-py2-none-any.whl (27.8 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: documenteer-0.2.4.tar.gz
  • Upload date:
  • Size: 36.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for documenteer-0.2.4.tar.gz
Algorithm Hash digest
SHA256 a3f616bcb2b6e99f15784af4e0f1fd327fc6f466c2313abc351ed4debc2ef203
MD5 39bf4be636f8555f834c336b84a284e7
BLAKE2b-256 037eb1a5a39883672c3fb08b68e1e0e4ad4055e22f82763546f4a49d0225e67b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d44dbea7c9c3abfb8c772e1308ac9ce52fc4565ef671bca7f5e358be80aeb1ec
MD5 e9f56e096a4be0b50705efac79f05204
BLAKE2b-256 7b95ebc13a7c12d5e25135eecc0a23eec826ccbb63c86479187434b1adffa515

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.4-py2-none-any.whl
Algorithm Hash digest
SHA256 f31904af5481efcbda37f42d25e01387b5cc427b5d87e24781c34442d79cab96
MD5 9a551c7819ba1b80d08de1e583fee747
BLAKE2b-256 b1ee46f1494c8a8d2a7ffdcf2df9cf9f26ed7a261cb2ac609b82d1d280bb13af

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