Move to mkdocs

py-mine · Aug 1, 2024 · 8288c8f · 8288c8f
1 parent 2dadf30
commit 8288c8f
Show file tree

Hide file tree

Showing 29 changed files with 563 additions and 1,679 deletions.
diff --git a/.github/workflows/mkdocs.yml b/.github/workflows/mkdocs.yml
@@ -0,0 +1,82 @@
+---
+name: MkDocs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  deploy-docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate token
+        id: app-token
+        uses: actions/create-github-app-token@v1
+        with:
+          app-id: ${{ secrets.APP_ID }}
+          private-key: ${{ secrets.PRIVATE_KEY }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: "${{ steps.app-token.outputs.token }}"
+
+      # Make the github application be the committer
+      # (see: https://stackoverflow.com/a/74071223 on how to obtain the committer email)
+      - name: Setup git config
+        run: |
+          git config --global user.name "py-mine-ci-bot"
+          git config --global user.email "121461646+py-mine-ci-bot[bot]@users.noreply.github.com"
+
+      - name: Setup poetry
+        id: poetry_setup
+        uses: ItsDrike/setup-poetry@v1
+        with:
+          python-version: 3.12
+          install-args: "--only main,docs"
+
+      - name: Generate docs directory hash
+        run: |
+          docs_dir_hash="$(find "./docs" -type f -exec sha256sum {} + | sort | sha256sum | awk '{print $1}')"
+          echo "docs_dir_hash=$docs_hash" >> $GITHUB_ENV
+
+      - name: Restore MkDocs cache
+        uses: actions/cache@v4
+        with:
+          path: .cache
+          key:
+            "mkdocs-material-${{ steps.poetry_setup.outputs.python-version }}-\
+            ${{ hashFiles('./poetry.lock') }}-${{ hashFiles('./mkdocs.yml') }}-\
+            ${{ env.docs_dir_hash }}"
+          restore-keys: "mkdocs-material-${{ steps.poetry_setup.outputs.python-version }}-"
+
+      - name: Build the documentation
+        run: poetry run mkdocs build
+
+      - name: Deploy preview
+        if: ${{ github.event_name == 'pull_request' }}
+        uses: rossjrw/pr-preview-action@v1
+        with:
+          source-dir: ./site
+          preview-branch: gh-pages
+          umbrella-dir: pr-preview
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Deploy production
+        if: ${{ github.event_name == 'push' }}
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          branch: gh-pages
+          folder: ./site
+          clean-exclude: pr-preview/
+          token: ${{ steps.app-token.outputs.token }}
diff --git a/.gitignore b/.gitignore
@@ -20,8 +20,8 @@ htmlcov/
 .coverage*
 coverage.xml
 
-# Sphinx documentation
-docs/_build/
+# Mkdocs documentation
+site/
 
 # Pyenv local version information
 .python-version

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/docs/_static/extra.css b/docs/_static/extra.css
diff --git a/docs/_static/extra.js b/docs/_static/extra.js
diff --git a/docs/api/basic.rst b/docs/api/basic.rst
diff --git a/docs/api/internal.rst b/docs/api/internal.rst
diff --git a/docs/api/packets.rst b/docs/api/packets.rst
diff --git a/docs/api/protocol.rst b/docs/api/protocol.rst
diff --git a/docs/api/types/index.rst b/docs/api/types/index.rst
diff --git a/docs/api/types/nbt.rst b/docs/api/types/nbt.rst
diff --git a/docs/assets/py-mine_logo.png b/docs/assets/py-mine_logo.png