docs: gh-pages deployment

.github/ISSUE_TEMPLATE/new-variant-request.md

@@ -15,7 +15,7 @@ assignees: ''
    * Where this hardware can be purchased
   * ...
 
-**Note that user can add a STM32 based board following this [wiki](https://github.com/stm32duino/Arduino_Core_STM32/wiki/Add-a-new-variant-(board))**
+**Note that users can add an STM32-based board by following this [variant development guide](https://stm32duino.github.io/development/Add-a-new-variant-%28board%29/)**
 
 Any contribution is welcome, so do not hesitate to submit a PR.
 

.github/workflows/docs-check.yml

@@ -0,0 +1,31 @@
+name: Documentation build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+    paths:
+      - docs/**
+      - boards.txt
+      - mkdocs.yml
+      - requirements-docs.txt
+      - .github/workflows/docs-check.yml
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m pip install -r requirements-docs.txt
+      - run: mkdocs build --strict
+      - name: Check generated supported boards page is committed
+        run: git diff --exit-code -- docs/Supported-boards.md || { echo "::error::Run 'python docs/hooks/supported_boards.py' and commit docs/Supported-boards.md"; exit 1; }

.github/workflows/publish-docs.yml

@@ -0,0 +1,70 @@
+name: Publish versioned core documentation
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - "[0-9]*"
+    paths:
+      - docs/**
+      - boards.txt
+      - mkdocs.yml
+      - requirements-docs.txt
+      - .github/workflows/publish-docs.yml
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: publish-root-docs
+  cancel-in-progress: false
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+      - run: python -m pip install -r requirements-docs.txt
+      - uses: actions/create-github-app-token@v1
+        id: pages-token
+        with:
+          app-id: ${{ secrets.DOCS_PUBLISH_APP_ID }}
+          private-key: ${{ secrets.DOCS_PUBLISH_APP_PRIVATE_KEY }}
+          owner: stm32duino
+          repositories: stm32duino.github.io
+          permission-contents: write
+      - name: Configure Pages remote
+        env:
+          PAGES_TOKEN: ${{ steps.pages-token.outputs.token }}
+        run: git remote add pages "https://x-access-token:${PAGES_TOKEN}@github.com/stm32duino/stm32duino.github.io.git"
+      - name: Publish development documentation
+        if: github.ref == 'refs/heads/main'
+        run: |
+          if git ls-remote --exit-code --heads pages gh-pages >/dev/null; then
+            mike deploy --remote pages --branch gh-pages --push dev
+          else
+            mike deploy --remote pages --branch gh-pages --default dev --push dev
+          fi
+      - name: Publish release documentation
+        if: startsWith(github.ref, 'refs/tags/')
+        env:
+          VERSION: ${{ github.ref_name }}
+        run: |
+          if [[ ! "$VERSION" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "Unsupported documentation release tag: $VERSION" >&2
+            exit 1
+          fi
+          latest=$(git tag --list | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | sort -V | tail -n 1)
+          if [[ "$VERSION" == "$latest" ]]; then
+            mike deploy --remote pages --branch gh-pages --update-aliases --push "$VERSION" latest
+            mike set-default --remote pages --branch gh-pages --push latest
+          else
+            mike deploy --remote pages --branch gh-pages --push "$VERSION"
+          fi

.gitignore

@@ -1,5 +1,6 @@
 # Specific
 build/
+site/
 astyle.out
 boards.local.txt
 platform.local.txt

CI/codespell/.codespellignore

@@ -9,4 +9,5 @@ ore
 shiftin
 socio-economic
 DAA
+als
 

CI/update/templates/boards_entry.txt

@@ -1,7 +1,7 @@
 # This file help to add generic board entry.
 # upload.maximum_size and product_line have to be verified
 # and changed if needed.
-# See: https://github.com/stm32duino/Arduino_Core_STM32/wiki/Add-a-new-variant-%28board%29
+# See: https://stm32duino.github.io/development/Add-a-new-variant-%28board%29/
 
 {% for generic in generic_list %}
 # Generic {{generic.name}}

CONTRIBUTING.md

@@ -99,4 +99,4 @@ More information about rebasing can be found at the repository of [edX](https://
 
 ### 6. Merged!
 When your pull request is merged please update the documentation if the changes require it
-[Wiki](https://github.com/stm32duino/Arduino_Core_STM32/wiki)
+[Documentation](https://stm32duino.github.io/)

README_CMAKE.md

@@ -2,7 +2,7 @@ CMake can now be used to build Arduino sketches with this core.
 Examples of use can be found on this repo: [stm32duino/CMake_workspace](https://github.com/stm32duino/CMake_workspace).
 
 This README only provides a quick walk-through.
-For all the glorious details, please head over to [the wiki](https://github.com/stm32duino/Arduino_Core_STM32/wiki/CMake-presentation).
+For the full walkthrough, see the [CMake documentation](https://stm32duino.github.io/cmake/CMake-presentation/).
 
 # Prerequisites