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.
OMERO 5.x series
Builds the OMERO documentation for review
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.
Review PRs opened against the OME Website
Review PRs opened against the Presentations website
For all jobs building documentation using Sphinx, the following environment variables are used:
the Sphinx building options,
SPHINXOPTS, is set to
the release number of the documentation is set by
BF_RELEASEor by the relevant POM
the source code links use
for the Bio-Formats and OMERO sets of documentation, the name of the Jenkins job is set by
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.
The following set of jobs is used to review or publish the content of the OME Jekyll websites.
This job is used to review the PRs opened against the master branch of https://github.com/ome/www.openmicroscopy.org
Merges PRs using scc merge and pushes the branch to https://github.com/snoopycrimecop/www.openmicroscopy.org/tree/merge_ci
The GitHub Pages service deploys the staging website content under https://snoopycrimecop.github.io/www.openmicroscopy.org/
This job is used to review the PRs opened against the master branch of https://github.com/ome/presentations