Documentation jobs

All documentation jobs are listed under the Docs view tab of Jenkins. A GitHub button in the left-side panel of the job window links to the code repository the job is building from (alternatively, the console output for the build will indicate where the changes are being fetched from).

More detail on how and where to edit OME documentation is available on the Editing the OME documentation page.

Job task

OMERO 5.x series

Builds the OMERO documentation for review

OMERO-docs

The Bio-Formats documentation jobs are described in the Bio-Formats jobs section.

The OME Model set is independent of the current OMERO/Bio-Formats version.

Job task

Review PRs opened against the OME Website

WEBSITE-push

Review PRs opened against the Presentations website

PRESENTATIONS-merge

Configuration

For all jobs building documentation using Sphinx, the following environment variables are used:

  • the Sphinx building options, SPHINXOPTS, is set to -Dsphinx.opts="-W"

  • the release number of the documentation is set by OMERO_RELEASE, BF_RELEASE or by the relevant POM

  • the source code links use SOURCE_USER and SOURCE_BRANCH

  • for the Bio-Formats and OMERO sets of documentation, the name of the Jenkins job is set by JENKINS_JOB.

Note that the https://github.com/ome/sphinx_theme repository is no longer used, this hosted the theme to match the old plone website.

OMERO 5.x series

The branch for the 5.x series of the OMERO documentation is develop.

OMERO-docs

This job is used to review the PRs opened against the develop branch of the OMERO 5.x documentation

  1. Merges PRs using scc merge

  2. Pushes the branch to merge_ci

  3. Runs make clean html to build the HTML Sphinx documentation

  4. Runs make linkcheck

Jekyll websites

The following set of jobs is used to review or publish the content of the OME Jekyll websites.

WEBSITE-push

This job is used to review the PRs opened against the master branch of https://github.com/ome/www.openmicroscopy.org

  1. Merges PRs using scc merge and pushes the branch to https://github.com/snoopycrimecop/www.openmicroscopy.org/tree/merge_ci

  2. The GitHub Pages service deploys the staging website content under https://snoopycrimecop.github.io/www.openmicroscopy.org/

PRESENTATIONS-merge

This job is used to review the PRs opened against the master branch of https://github.com/ome/presentations

  1. Merges PRs using scc merge and pushes the branch to https://github.com/snoopycrimecop/presentations

  2. The GitHub Pages service deploys the staging website content under https://snoopycrimecop.github.io/presentations/