Skip to content


Configures a job that publishes the output of a Sphinx build with Gitlab Pages.


  - component:<VERSION>


Automatically configurable from the build components

Publication of Sphinx sites can be automated without manually including this component by specifying the pages_when input for either the sphinx/apidoc and sphinx/build components.


Input Default value Description
stage "deploy" Pipeline stage to add jobs to (must be configured in stages)
needs ["sphinx"] The job(s) whose artefacts are to be published
sphinx_outputdir "sphinx" Sphinx build output directory to publish
pages_when "never" When to automatically publish the documentation using Gitlab Pages, one of "tags" (for all git tags), "default" (pushes to the project default branch)