Installing Documenteer for pipelines.lsst.io

Installation in the Stack environment

The “pipelines” version of Documenteer provides additional dependencies needed to build the pipelines.lsst.io documentation site for the LSST Science Pipelines. Since Documenteer needs to work inside the Python environment of LSST DM’s EUPS Stack, the safest way to install Documenteer is in a virtual environment layered on top of the Stack’s Python.

First, install and set up the LSST Science Pipeline Stack.

Then create a virtual environment and install the “pipelines” version of Documenteer into it:

python -m venv --system-site-packages --without-pip pyvenv
source pyvenv/bin/activate
curl https://bootstrap.pypa.io/get-pip.py | python
pyvenv/bin/pip install "documenteer[pipelines]"

Documenteer requires Python 3.5 and newer.

Tip

When working with the LSST Science Pipelines, the best method for installing Documenteer is through the requirements.txt file in the pipelines_lsst_io repository. This way your working copy of Documenteer is compatible with the documentation project.

Further reading