Skip to main content

Tools for LSST DM documentation projects

Project description

PyPI MIT license Uses wheel For Python 3.5+


Sphinx documentation tools for LSST Data Management projects.

Browse the lsst-doc-engineering GitHub topic for more LSST documentation engineering projects.


How you install Documenteer depends on the project you’re using it for:

  • For technical note projects: pip install documenteer[technote]
  • For the project: pip install documenteer[pipelines]


Create a virtual environment with your method of choice (virtualenvwrapper or conda) and then clone or fork, and install:

git clone
cd documenteer
pip install -e ".[dev]"

To make a release:

  1. Update CHANGELOG.rst.
  2. Tag: git tag -s X.Y.Z -m "X.Y.Z"
  3. Push: git push --tags

Use a PEP 440-compliant version identifiers.

Travis CI 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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for documenteer, version 0.5.8
Filename, size File type Python version Upload date Hashes
Filename, size documenteer-0.5.8-py3-none-any.whl (59.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size documenteer-0.5.8.tar.gz (72.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page