Skip to content

Add online documentation build/deployment to conda Jenkins pipeline. #33021

@thomashampson

Description

@thomashampson

Add steps to the deployment pipeline to publish the online user documentation (https://docs.mantidproject.org).

The built HTML is stored in either:

A step needs to be added to the build/deployment pipeline to build the HTML documentation and then publish it to the relevant repository.

Requirements:

  • Separate build & publishing steps so that build_packages_with_branch still builds the docs (to check them) but if publishing is disabled the output is just archived
  • Similarly to package-conda and package-standalone a script should encapsulate the steps required to build the documentation that can be run by a developer locally.
  • Use the following documentation options in CMake:
    • DOCS_HTML=ON
    • DOCS_DOTDIAGRAMS=ON
    • DOCS_SCREENSHOTS=ON
    • DOCS_MATH_EXT="sphinx.ext.mathjax" (Use javascript for equations. Reduces the size and speeds up the build)
    • DOCS_PLOTDIRECTIVE=ON

Nice to have:

  • Avoid a full build Mantid again when building the documentation. Can we leverage the fact that we will have built the Conda packages and just install them to built the HTML?

For reference, the old non-conda, non-pipeline HTML docs were built by this script.

Metadata

Metadata

Assignees

Labels

ISIS: CoreIssue and pull requests at ISIS that relate to Core features and functions

Type

No type

Projects

Status

No status

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions