Installing Documenteer for pipelines.lsst.io

The “pipelines” version of Documenteer provides additional dependencies needed to build the pipelines.lsst.io documentation site for the LSST Science Pipelines.

At the moment, the recommended procedure for installing Documenteer for stack work is to pip-install it into the set up Conda environment, using the version corresponding to the master branch of the pipelines_lsst_io repository.

Prerequisites

Before starting this tutorial, you’ll need a working stack. For more information, see the LSST Science Pipelines installation guide.

The stack environment must be set up in the shell that you are installing Documenteer with.

Pip installation of Documenteer

Install Documenteer based on the requirements of the pipelines_lsst_io repository:

curl -O https://raw.githubusercontent.com/lsst/pipelines_lsst_io/master/requirements.txt
pip install -r requirements.txt

Tip

Do this step after having set up the stack with the setup command.