ProperDocs Compatibility

.github/workflows/ci.yml

@@ -5,12 +5,14 @@ on:
     branches:
       - main
   pull_request:
+    types: ['opened', 'edited', 'reopened', 'synchronize', 'ready_for_review']
     branches:
       - '**'
 
 
 jobs:
   test:
+    if: github.event.pull_request.draft == false || github.event_name != 'pull_request'
     strategy:
       max-parallel: 5
       matrix:
@@ -44,6 +46,7 @@ jobs:
         shell: bash
 
   lint:
+    if: github.event.pull_request.draft == false || github.event_name != 'pull_request'
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.github/workflows/deploy-docs.yml

@@ -1,26 +1,46 @@
-name: deploy
-on:
+name: deploy 
+on: 
   push:
     branches:
-      - main
-permissions:
-  contents: write
-jobs:
-  deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
+      - main 
+  workflow_dispatch:
+
+permissions: 
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: github-pages
+  cancel-in-progress: true
+
+jobs: 
+  build: 
+    runs-on: ubuntu-latest 
+    steps: 
+      - uses: actions/checkout@v4 
         with:
           fetch-depth: 0
-      - name: Configure Git Credentials
-        run: |
-          git config user.name github-actions[bot]
-          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@v5 
         with:
           python-version: 3.x
           cache: 'pip'
-      - name: Install Python dependencies
-        run: python -m pip install --upgrade hatch
-      - name: Build and deploy
-        run: hatch -e doc run mkdocs gh-deploy --force
+      - name: Install dependencies 
+        run: pip install -r requirements.txt
+      - name: Build 
+        run: properdocs build --clean
+      - name: Upload static files as artifact 
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./site/ 
+
+  deploy: 
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest 
+    needs: build 
+    steps: 
+      - name: Deploy to GitHub Pages 
+        id: deployment
+        uses: actions/deploy-pages@v4

mkdocs_data_plugin/__init__.py

@@ -1 +1,5 @@
-version = "0.2.0"
+import properdocs.replacement_warning
+
+properdocs.replacement_warning.setup()
+
+version = "0.3.0"

mkdocs.yml → properdocs.yml

@@ -17,7 +17,7 @@ exclude_docs: |
   _*
 
 theme:
-  name: material
+  name: materialx
   icon:
     logo: material/file-send-outline
   palette:

pyproject.toml

@@ -16,7 +16,8 @@ classifiers = [
     "Topic :: Software Development :: Libraries :: Python Modules",
 ]
 dependencies = [
-    "mkdocs>=1.5.2",
+    "mkdocs>=1.5.2,<2.0",
+    "properdocs>=1.6",
     "mkdocs-macros-plugin>=1.2.0",
 ]
 
@@ -63,17 +64,17 @@ type = ["default"]
 
 [tool.hatch.envs.doc]
 dependencies = [
-    "mkdocs-material[imaging]~=9.5",
+    "mkdocs-materialx[imaging]~=10.1",
     "mkdocs-alias-plugin~=0.8",
     "mkdocs-git-revision-date-localized-plugin~=1.2",
 ]
 
 [tool.hatch.envs.doc.scripts]
 serve = [
-    "mkdocs serve",
+    "properdocs serve",
 ]
 build = [
-    "mkdocs build",
+    "properdocs build",
 ]
 
 [tool.hatch.envs.style]