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 hashes)

Uploaded Source

Built Distributions

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

Uploaded Python 3

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

Uploaded Python 2

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