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

History Node

0.3.0a5

History Node

0.3.0a4

History Node

0.3.0a3

History Node

0.3.0a2

History Node

0.3.0a1

This version
History Node

0.2.8

History Node

0.2.7

History Node

0.2.6

History Node

0.2.5

History Node

0.2.4

History Node

0.2.3

History Node

0.2.2

History Node

0.2.1

History Node

0.2.0

History Node

0.1.11

History Node

0.1.10

History Node

0.1.9

History Node

0.1.8

History Node

0.1.7

History Node

0.1.6

History Node

0.1.5

History Node

0.1.4

History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

History Node

0.1.0.dev0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
documenteer-0.2.8-py3-none-any.whl (25.4 kB) Copy SHA256 hash SHA256 Wheel py3 May 10, 2018
documenteer-0.2.8.tar.gz (36.0 kB) Copy SHA256 hash SHA256 Source None May 10, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page