ci: use mdbook to create documentation

striezel · striezel · commit b6a573dbf221 · 2025-08-31T18:19:31.000+02:00
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
@@ -0,0 +1,44 @@
+name: Documentation
+
+on: push
+
+jobs:
+  doc:
+    runs-on: ubuntu-latest
+    steps:
+      # Checks-out the repository under $GITHUB_WORKSPACE.
+      - name: Git checkout
+        uses: actions/checkout@v5
+        with:
+          submodules: 'recursive'
+          persist-credentials: false
+      - name: Install Debian packages
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y wget
+      - name: Download mdbook
+        run: |
+          wget https://github.com/rust-lang/mdBook/releases/download/v0.4.52/mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz
+          CHECKSUM=$(sha256sum mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz)
+          CHECKSUM_BITS=$(echo $CHECKSUM | cut -f 1 -d' ')
+          echo Checksum calculation: $CHECKSUM
+          CHECKSUM_BITS=$(echo $CHECKSUM | cut -f 1 -d' ')
+          if [[ "$CHECKSUM_BITS" != "c0b903f01dd8f4edc644372ad2b80b1fdddd12552d37b6a098657cbd8eddd768" ]]
+          then
+            echo "Checksum of downloaded mdbook is wrong."
+            exit 1
+          fi
+          tar xf mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz
+          mv ./mdbook /usr/local/bin/
+          unlink mdbook-v0.4.52-x86_64-unknown-linux-gnu.tar.gz
+      - name: Generate documentation
+        run: |
+          cd "$GITHUB_WORKSPACE"/documentation
+          mdbook build
+      - name: Collect documentation artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: pmdb-documentation
+          if-no-files-found: error
+          path: |
+            "$GITHUB_WORKSPACE"/documentation/book/
diff --git a/documentation/.gitignore b/documentation/.gitignore
@@ -0,0 +1 @@
+book
diff --git a/documentation/SUMMARY.md b/documentation/SUMMARY.md
@@ -0,0 +1,9 @@
+# pmdb
+
+[Location of pmdb's files](directories.md)
+
+[Templates](templates.md)
+
+[Configuration file](configuration.md)
+
+[Frequently asked questions](faq.md)
diff --git a/documentation/book.toml b/documentation/book.toml
@@ -0,0 +1,3 @@
+[book]
+language = "en"
+src = "."

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+[book]`
	`2`	`+language = "en"`
	`3`	`+src = "."`