docs(build): add the possibility to push regular files in docs

Author: MartinFillon

.github/workflows/deploy.yml

@@ -36,13 +36,13 @@ jobs:
           pip install sphinx sphinx_rtd_theme myst_parser
       - name: build docs
         run: |
-          sphinx-build -d html . gh-pages
+          ./build.sh
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: './gh-pages'
+          path: "./gh-pages"
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v4

build.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -e
+
+OUTPUT_DIR=${1:-gh-pages}
+
+# Regular sphinx build
+
+sphinx-build -d html . "$OUTPUT_DIR"
+
+# Copy following files into output directory
+
+INCLUDES_FILES=$(find . -type f | grep '\.gh-include$')
+
+while IFS= read -r file; do
+    while IFS= read -r include_file; do
+        dest_file="$OUTPUT_DIR/$(dirname "$file")/$include_file"
+        mkdir -p "$OUTPUT_DIR/$(dirname "$file")"
+        cp "$(dirname "$file")/$include_file" "$dest_file"
+    done < "$file"
+done <<< "$INCLUDES_FILES"

cli/docs/.gh-include

@@ -0,0 +1 @@
+config.schema.json