Add step to build the documentation (#4549)

* 💚 add step to build the documentation * 💚 add step to build the documentation
nlohmann · Dec 17, 2024 · f2a4ac0 · f2a4ac0
1 parent 8e1b800
commit f2a4ac0
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml
@@ -290,7 +290,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        target: [ci_test_examples, ci_test_api_documentation]
+        target: [ci_test_examples, ci_test_build_documentation]
     steps:
       - name: Harden Runner
         uses: step-security/harden-runner@0080882f6c36860b6ba35c610c98ce87d4e2f26f # v2.10.2

diff --git a/cmake/ci.cmake b/cmake/ci.cmake
@@ -1023,10 +1023,12 @@ add_custom_target(ci_test_examples
     COMMENT "Check that all examples compile and create the desired output"
 )
 
-add_custom_target(ci_test_api_documentation
-    COMMAND ${Python3_EXECUTABLE} ../scripts/check_structure.py
-    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs/mkdocs/docs
-    COMMENT "Lint the API documentation"
+add_custom_target(ci_test_build_documentation
+    COMMAND ${Python3_EXECUTABLE} -mvenv venv
+    COMMAND venv/bin/pip3 install -r requirements.txt
+    COMMAND make build
+    WORKING_DIRECTORY ${PROJECT_SOURCE_DIR}/docs/mkdocs
+    COMMENT "Build the documentation"
 )
 
 ###############################################################################