Sphinx extensions, configurations, and tooling for LSST Data Management documentation projects
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
documenteer
licenses
tests
.gitattributes
.gitignore
.travis.yml
CHANGELOG.rst
LICENSE
MANIFEST.in
README.rst
setup.cfg
setup.py

README.rst

PyPI MIT license Uses wheel For Python 3.5+

Documenteer

Sphinx documentation tools for LSST Data Management projects.

Browse the lsst-doc-engineering GitHub topic for more LSST documentation engineering 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 ".[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.