documenteer)¶

The sqre/infra/documenteer Jenkins CI job enables you to create a new build of pipelines.lsst.io. Since pipelines.lsst.io is published through LSST the Docs, builds for development branches appear as new editions from the pipelines.lsst.io/v version dashboard.

Important

You can’t use this Jenkins CI job to test development branches of packages with the pipelines.lsst.io site build. This Jenkins CI job always uses packages corresponding to a released EUPS tag (such as a daily, weekly, or stable release). Only the branch of the pipelines_lsst_io repository can be modified.

If you need to build and test your package’s documentation, you can do so locally with these methods:

Running the documenteer Jenkins CI job¶

Go to the sqre/infra/documenteer job’s page, then click the Run button.

The following sections describe how to set each form field.

EUPS distrib tag name¶

This is the EUPS tag of the lsst_distrib Stack. You can set this to a stable release, weekly release, or a daily release.

This means that you can only build documentation for tags of Stack packages that have been released by Jenkins CI.

LTD edition slug¶

Set this field to either a Git ref or an EUPS tag. Follow these guidelines:

If you are building with a non-master Git ref of the pipelines_lsst_io repository (see git repo ref), set this field to the name of the pipelines_lsst_io branch being built.
If you are building with a master Git ref of the pipelines_lsst_io repository, set this to the EUPS distrib tag name.

LSST the Docs uses this information to populate the version slug of the edition (the part of the URL after /v/).

github repo slug¶

This is the GitHub repository slug for the main documentation repository. This should always be lsst/pipelines_lsst_io.

git repo ref¶

This is the name of the Git branch or tag of the main documentation repository (pipelines_lsst_io) that you want to build.

Note

During development, tickets/DM-11216 is the integration branch for the Jenkins-enabled pipelines_lsst_io-enabled repository. The master branch currently doesn’t work with the Jenkins CI-based build.

Explicit name of release docker image including tag¶

Leave this field blank.

Run the Job¶

Ensure that the Publish option is checked so that the build site is published as a development branch on pipelines.lsst.io.

Viewing the results¶

Once the job successfully finishes, open pipelines.lsst.io/v and find the corresponding edition that you just built.