Merge pull request #298 from clue-labs/mkdocs-instructions

Improve mkdocs instructions to build docs with correct directory permissions and allow using SIGINT to stop

Author: clue

.github/workflows/ci.yml

@@ -231,5 +231,6 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v6
-      - run: docker compose -f docs/compose.yaml run build
+      - run: docker compose -f docs/compose.yaml pull
+      - run: mkdir -p build/ && docker compose -f docs/compose.yaml run --rm -u $(id -u):$(id -g) build
       - run: ls -la build/docs/

docs/README.md

@@ -29,7 +29,7 @@ If you want to generate a static HTML folder for deployment, you can again
 use a Docker container in the project root directory like this:
 
 ```bash
-docker compose -f docs/compose.yaml run -u $(id -u) build
+mkdir -p build/ && docker compose -f docs/compose.yaml run --rm -u $(id -u):$(id -g) build
 ```
 
 The resulting `build/docs/` should then be deployed behind a web server.

docs/compose.yaml

@@ -8,6 +8,7 @@ services:
     volumes:
       - ./mkdocs.yml:/project/mkdocs.yml:ro
       - ./:/project/docs/:ro
+    stop_signal: SIGINT
 
   build:
     extends: mkdocs