Skip to content


Configure a job to build a Sphinx documentation project.


  - component:<VERSION>
      stage: build


Input Default value Description
stage test The pipeline stage to add jobs to
python "python" Name/path of Python interpreter to use
job_name "sphinx" Name to give the build job
image python Container image in which to build the documentation
builder "html" Sphinx builder to use
source_dir None Path of directory containing the Sphinx configuration file (
requirements "" Extra packages to install (with pip) before building
sphinx_options "" Extra options to pass to sphinx-build
sphinx_outputdir "sphinx" Sphinx build output directory
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), or "never! (don't publish anything)