Add the wolfTPM manual as an in-repo docs/ source with build tooling

.github/workflows/codespell.yml

@@ -34,4 +34,4 @@ jobs:
         run: |
           codespell --count \
             --skip '.git,./IDE,./certs,./m4,*.der,*.pem,*prebuilt_bindings.rs' \
-            --ignore-words-list 'inh,inout,keypair,nd,parm,rcv,ser,loadIn,importIn,certifyIn,bu,fo,daa,pris,hsi,fram,hart,cna'
+            --ignore-words-list 'inh,inout,keypair,nd,parm,rcv,ser,loadIn,importIn,certifyIn,bu,fo,daa,pris,hsi,fram,hart,cna,challener'

.github/workflows/docs-site.yml

@@ -0,0 +1,93 @@
+name: Build manual with documentation tooling
+
+on:
+  pull_request:
+    paths: &doc_paths
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'mkdocs-ja.yml'
+      - 'tools/docs_manual.py'
+      - 'tools/docs-manual/**'
+      - 'docker/docs/**'
+      - '.github/workflows/docs-site.yml'
+      - 'README.md'
+      - 'docs/Doxyfile'
+      - 'examples/README.md'
+      - 'examples/pcr/README.md'
+      - 'examples/attestation/README.md'
+      - 'examples/boot/README.md'
+      - 'hal/README.md'
+      - 'hal/tpm_io.h'
+      - 'wolftpm/tpm2.h'
+      - 'wolftpm/tpm2_wrap.h'
+      - 'wolftpm/tpm2_crypto.h'
+      - 'wolftpm/fwtpm/*.h'
+  push:
+    branches: [master]
+    paths: *doc_paths
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: read
+
+jobs:
+  build:
+    runs-on: ubuntu-24.04
+    timeout-minutes: 60
+    steps:
+      - uses: actions/checkout@v4
+      - name: Select documentation revision
+        id: documentation
+        run: echo "sha=$(cat tools/docs-manual/documentation-rev)" >> "$GITHUB_OUTPUT"
+      - uses: actions/checkout@v4
+        with:
+          repository: wolfSSL/documentation
+          ref: ${{ steps.documentation.outputs.sha }}
+          path: build/documentation
+          submodules: recursive
+          persist-credentials: false
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Pull documentation builder
+        run: |
+          set -euo pipefail
+          image_sha=$(sha256sum docker/docs/Dockerfile docker/docs/requirements.txt | sha256sum | cut -c1-16)
+          image="ghcr.io/wolfssl/wolftpm-docs:sha-$image_sha"
+          if ! docker pull "$image"; then
+            docker build --pull -t "$image" docker/docs
+          fi
+          echo "DOCS_IMAGE=$image" >> "$GITHUB_ENV"
+      - name: Build and validate HTML and PDF (English and Japanese)
+        run: |
+          tools/check-docs-no-internal-links.sh --selftest
+          tools/check-docs-no-internal-links.sh
+          docker run --rm --user "$(id -u):$(id -g)" --env HOME=/tmp \
+            --mount "type=bind,source=$GITHUB_WORKSPACE,target=/work/wolfTPM" \
+            --workdir /work/wolfTPM "$DOCS_IMAGE" \
+            sh -c '
+              set -e
+              python3 tools/docs_manual.py build --documentation-root /work/wolfTPM/build/documentation --source-root /work/wolfTPM --target all
+              test -s build/documentation/wolfTPM/html/index.html
+              test -s build/documentation/wolfTPM/wolfTPM-Manual.pdf
+              cp -r build/documentation/wolfTPM/html build/documentation/wolfTPM/html-en
+              python3 tools/docs_manual.py build --documentation-root /work/wolfTPM/build/documentation --source-root /work/wolfTPM --lang ja --target all
+              test -s build/documentation/wolfTPM/html/index.html
+              test -s build/documentation/wolfTPM/wolfTPM-Manual-jp.pdf
+              cp -r build/documentation/wolfTPM/html build/documentation/wolfTPM/html-ja
+            '
+          test -s build/documentation/wolfTPM/wolfTPM-Manual.pdf
+          test -s build/documentation/wolfTPM/wolfTPM-Manual-jp.pdf
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wolftpm-manual
+          path: |
+            build/documentation/wolfTPM/html-en/
+            build/documentation/wolfTPM/html-ja/
+            build/documentation/wolfTPM/wolfTPM-Manual.pdf
+            build/documentation/wolfTPM/wolfTPM-Manual-jp.pdf
+          if-no-files-found: error
+          retention-days: 14

.github/workflows/publish-docs-image.yml

@@ -0,0 +1,42 @@
+name: Publish documentation image
+
+on:
+  push:
+    branches: [master]
+    paths:
+      - 'docker/docs/**'
+      - '.github/workflows/publish-docs-image.yml'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  packages: write
+
+concurrency:
+  group: publish-wolftpm-docs-image
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    if: github.repository == 'wolfSSL/wolfTPM'
+    runs-on: ubuntu-24.04
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - name: Select image tag
+        id: image
+        run: |
+          image_sha=$(sha256sum docker/docs/Dockerfile docker/docs/requirements.txt | sha256sum | cut -c1-16)
+          echo "tag=ghcr.io/wolfssl/wolftpm-docs:sha-$image_sha" >> "$GITHUB_OUTPUT"
+      - uses: docker/setup-buildx-action@v3
+      - uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+      - uses: docker/build-push-action@v6
+        with:
+          context: docker/docs
+          file: docker/docs/Dockerfile
+          push: true
+          tags: ${{ steps.image.outputs.tag }}

.gitignore

@@ -17,6 +17,7 @@ libtool
 Makefile
 !/wrapper/rust/Makefile
 !/wrapper/rust/wolftpm/Makefile
+!/tools/docs-manual/Makefile
 wolftpm-config
 .dirstamp
 *.la