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

Uploaded Source

Built Distributions

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

Uploaded Python 3

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

Uploaded Python 2

File details

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

File metadata

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

File hashes

Hashes for documenteer-0.2.5.tar.gz
Algorithm Hash digest
SHA256 6852c052e7d8f0b4d27cc0ac67315c3b149e625d9969204734e82f8d609a906a
MD5 32fc70a81eda7dd9f626de47ba0d9457
BLAKE2b-256 90e86f4806430579156795059eb6cb9a139294e1892ebc804e55e89662bd130f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 644a35e1360dc45316062dfced232b7386cbcfcf8e0c0a0f6fffd9bc47879149
MD5 768897cd6c3edb9bece5c5432cd2d8f1
BLAKE2b-256 974b519a0ecaa53b2b3f957936cea1f516d754947ab517622322720f3a87e789

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for documenteer-0.2.5-py2-none-any.whl
Algorithm Hash digest
SHA256 073143204e8e95740ee4ac177da8c05e63f344123a503a292d79aa3e386db128
MD5 2d36bd354e43208f0f6a5df7cf450450
BLAKE2b-256 bec60a8bae8dbd4171a5ea6115e5f9b9b12b85b09e6e9a0243c7f03bcae90a1e

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