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

Uploaded Source

Built Distributions

documenteer-0.2.1-py3-none-any.whl (24.6 kB view details)

Uploaded Python 3

documenteer-0.2.1-py2-none-any.whl (24.6 kB view details)

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for documenteer-0.2.1.tar.gz
Algorithm Hash digest
SHA256 e56ddf35ceb26b71e84cb23633e0f1f4c902b036c5fe7b967292546d56ffa697
MD5 3523d36b9a253d247a8e494d1c04dd4e
BLAKE2b-256 acd9858e005949c5c7887a1707a913a01006ecda60891b9f9428e285719d0d3b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 742a7253e955997544be799d3df4e05cb3de3b907ed86e574d7d73380cf02f30
MD5 32724e86b85cf1cdd6a7e37ccb85779d
BLAKE2b-256 3ab6cd476dc1d38a4ab0c1d81ef193425a05b195984e22835f532b3ec5050972

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.1-py2-none-any.whl
Algorithm Hash digest
SHA256 c0af40a762c07040521d8133bd180a04f3cc36b62c0fe734026d861cee9e4a44
MD5 63887ad200ec11dece2fe691512b6ebe
BLAKE2b-256 9e5759c8c106f7d9c143d6988118e4ad6f9c41ea0257e30944abf124b102a5fb

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