switch to mkdocs

Author: 2bndy5

.config/.readthedocs.yaml

@@ -9,20 +9,16 @@ build:
   os: ubuntu-22.04
   tools:
     rust: latest
-  commands:
-    # install cargo-binstall
-    - >-
-      curl
-      -L --proto '=https' --tlsv1.2 -sSf
-      https://raw.githubusercontent.com/cargo-bins/cargo-binstall/main/install-from-binstall-release.sh
-      | bash
-    # add .cargo bin to PATH
-    # install mdbook and mdbook-alerts
-    # build docs
-    - >-
-      PATH=/home/docs/.cargo/bin:$PATH &&
-      cargo binstall --install-path /home/docs/.cargo/bin -y mdbook mdbook-alerts &&
-      mdbook build docs
-    # move HTML output to required RTD output path
-    - mkdir -p ${READTHEDOCS_OUTPUT}
-    - mv docs/book/html/ "${READTHEDOCS_OUTPUT}"
+    python: latest
+
+mkdocs:
+  configuration: docs/mkdocs.yml
+
+
+# Optionally declare the Python requirements required to build your docs
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: docs/

.github/workflows/build-docs.yml

@@ -36,7 +36,7 @@ jobs:
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
       - run: cargo fetch
 
-  build-mdbook:
+  build-mkdocs:
     runs-on: ubuntu-latest
     needs: [cache-deps]
     permissions:
@@ -48,26 +48,30 @@ jobs:
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
-      - name: Install mdbook
-        uses: taiki-e/install-action@v2
+      - uses: actions/setup-python@v5
         with:
-          tool: mdbook,cargo-binstall,just
-      - name: Install mdbook plugins
-        run: cargo binstall -y mdbook-alerts
+          python-version: 3.x
+          cache: 'pip'
+          cache-dependency-path: docs/requirements.txt
+      - name: Install workflow deps
+        run: |
+          pip install -r docs/requirements.txt
+          pip install --force-reinstall -v docs/
       - name: Build book
-        run: just docs-build
+        working-directory: docs
+        run: mkdocs build
       - name: Upload docs build as artifact
         uses: actions/upload-artifact@v4
         with:
           name: cpp-linter-docs
-          path: docs/book/html
+          path: docs/site
       - name: Upload to github pages
         # only publish doc changes from main branch
         if: github.ref == 'refs/heads/main'
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/book/html
+          publish_dir: docs/site
 
   build-rustdoc:
     runs-on: ubuntu-latest
@@ -80,7 +84,7 @@ jobs:
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-docs-cargo-${{ hashFiles('Cargo.lock') }}
-      - name: Install mdbook
+      - name: Install just
         uses: taiki-e/install-action@v2
         with:
           tool: just