switch to mdbook for docs (#13)

See also [mdbook docs](https://rust-lang.github.io/mdBook/index.html)

This is pretty customized. The CLI doc is still generated from rust src.
The doc's site ToC is altered via JS on page load to show the page's ToC.

I also renamed some CI workflows to reduce the badges' visual noise (in README).

Author: 2bndy5

.github/workflows/binary-builds.yml

@@ -1,4 +1,4 @@
-name: Binary executable builds
+name: Binary builds
 
 permissions:
   contents: read

.github/workflows/build-docs.yml

@@ -18,44 +18,38 @@ jobs:
           key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }}
       - run: cargo fetch
 
-  build-sphinx:
+  build-mdbook:
     runs-on: ubuntu-latest
     needs: [cache-deps]
     permissions:
       contents: write
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-        with:
-          python-version: 3.x
-
-      - name: Install dependencies
-        working-directory: cpp-linter-py
-        run: pip install -r docs/requirements.txt
-
       - name: Cache .cargo locked resources
         uses: actions/cache/restore@v4
         with:
           path: ~/.cargo
           key: ${{ runner.os }}-cargo-${{ hashFiles('Cargo.lock') }}
-
-      - name: Build docs
-        working-directory: cpp-linter-py
-        run: sphinx-build docs docs/_build/html
-
+      - name: Install mdbook
+        uses: taiki-e/install-action@v2
+        with:
+          tool: mdbook,cargo-binstall
+      - name: Install mdbook plugins
+        run: cargo binstall -y mdbook-alerts
+      - name: Build book
+        run: mdbook build docs
       - name: Upload docs build as artifact
         uses: actions/upload-artifact@v4
         with:
-          name: cpp-linter-py_docs
-          path: cpp-linter-py/docs/_build/html
-
+          name: cpp-linter-docs
+          path: docs/book/html
       - 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: cpp-linter-py/docs/_build/html
+          publish_dir: docs/book/html
 
   build-rustdoc:
     runs-on: ubuntu-latest

.github/workflows/python-packaging.yml

@@ -1,4 +1,4 @@
-name: Python packaging
+name: Python builds
 
 on:
   push:

.gitignore

@@ -193,6 +193,8 @@ debug/
 # ignore vscode stuff
 .vscode/
 
+# mdbook builds
+book
 
 # ignore generated files
 .cpp-linter_cache/