[PATCH i-g-t 3/3] gitlab-ci: Add MkDocs documentation support

Pawel Sikora pawel.sikora at intel.com
Wed Jul 30 08:54:28 UTC 2025


From: Pawel Sikora <pawel.sikora at linux.intel.com>

This commit ensures two things:

 * The API reference manual is built and copied to the MkDocs documentation directory.

 * The MkDocs documentation (from the docs directory) is also built.

As a result, the existing API reference manual will still be available via an internal
link in the MkDocs documentation.
(Note: the API reference will retain its original theme for now.)

A relative link to api_reference/index.html is included in the MkDocs navigation.
This file will be generated by the deploy job after the API reference manual is built.

After both builds are complete, all content will be copied into the site directory
and then manually moved into public, for hosting on freedesktop GitLab Pages.

Signed-off-by: Pawel Sikora <pawel.sikora at linux.intel.com>
---
 .gitlab-ci.yml | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index 8098f2b70..3e1da8734 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -75,12 +75,15 @@ build:tests-fedora:
   stage: build
   script:
     - meson setup --prefix=/opt/igt $MESON_OPTIONS build
+    - pip install -r docs/requirements-docs.txt
     - ninja -C build -j${FDO_CI_CONCURRENT:-4} || ninja -C build -j 1
     - ninja -C build -j${FDO_CI_CONCURRENT:-4} igt-gpu-tools-doc
+    - cd docs && mkdocs build && cd ..
     - DESTDIR="$PWD/installdir" ninja -C build install
   artifacts:
     paths:
       - build
+      - site
       - installdir
 
 build:tests-fedora-no-libunwind:
@@ -241,8 +244,11 @@ pages:
     - build:tests-fedora
   stage: deploy
   script:
-    - ninja -C build -j${FDO_CI_CONCURRENT:-4} igt-gpu-tools-doc
-    - cp -r build/docs/reference/igt-gpu-tools/html public
+    - pip install -r docs/requirements-docs.txt
+    - cp -r build/docs/reference/igt-gpu-tools/html/ docs/api_reference
+    - mkdir -p docs/api_reference
+    - cd docs && mkdocs build && cd ..
+    - cp -r site public
   artifacts:
     paths:
       - public
-- 
2.34.1



More information about the igt-dev mailing list