Code on Software Factory

GitLab Documentation

Mon, 01 Jan 0001 00:00:00 +0000

Automated Documentation with Sphinx

Create a .gitlab-ci.yml file if it does not already exist.

Add a job for generating documentation. For example:

stages:
 - build
 - docs

generate_docs:
 stage: docs
 image: sphinxdoc/sphinx
 script:
 - sphinx-build -b html source/ build/html
 artifacts:
 paths:
 - build/html

Configure your pipeline to trigger the documentation generation job on relevant events, such as merging to the main branch or tagging a release.