Refactor: use uv (#32)

* Refactor code structure for improved readability and maintainability

* fix tags

Author: tlambert03

.github/workflows/deploy-pages.yml

@@ -17,31 +17,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: ✅ Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
         with:
           fetch-depth: 0 # needed for git committers
 
       - name: 🐍 Install Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.x"
+        uses: astral-sh/setup-uv@v6
 
       - name: 🔗 Check Links
         run: |
           npm install markdown-link-check@"<3.11.1"
           npx markdown-link-check docs/**/*.md --progress -q
 
       - name: 📚 Build Docs
-        run: |
-          pip install -U pip
-          pip install -r requirements.txt
-          mkdocs build --strict
+        run: uv run mkdocs build --strict
         env:
           MKDOCS_GIT_COMMITTERS_APIKEY: ${{ secrets.GITHUB_TOKEN }}
           GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
 
       - name: ⬆️ Upload Pages Artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v4
         with:
           path: "site/"
 
@@ -55,4 +50,4 @@ jobs:
     steps:
       - name: 🚀 Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v1
+        uses: actions/deploy-pages@v4

.pre-commit-config.yaml

@@ -4,6 +4,10 @@ repos:
     hooks:
       - id: trailing-whitespace
       - id: end-of-file-fixer
+  - repo: https://github.com/rhysd/actionlint
+    rev: v1.7.7
+    hooks:
+      - id: actionlint
   - repo: https://github.com/igorshubovych/markdownlint-cli
     rev: v0.43.0
     hooks:

.python-version

@@ -0,0 +1 @@
+3.13

README.md

@@ -10,6 +10,5 @@
 To run the dev site locally
 
 ```bash
-pip install -r requirements.txt
-mkdocs serve
+uv run mkdocs serve
 ```

docs/.overrides/partials/nav-item.html

@@ -1,3 +1,3 @@
 # Tags
 
-[TAGS]
+<!-- material/tags -->

docs/tags.md

@@ -121,17 +121,16 @@ markdown_extensions:
       line_spans: __span
       pygments_lang_class: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
   - pymdownx.tabbed:
       alternate_style: true
   - toc:
       permalink: "#"
 
 plugins:
   - search
-  - tags:
-      tags_file: tags.md
+  - tags
   - git-revision-date-localized:
       enable_creation_date: true
       type: timeago

mkdocs.yml

@@ -0,0 +1,16 @@
+[project]
+name = "pydev-guide-github-io"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "mkdocs-git-committers-plugin>=0.2.3",
+    "mkdocs-git-revision-date-localized-plugin>=1.4.7",
+    "mkdocs-material>=9.6.20",
+    "mkdocs-minify-plugin>=0.8.0",
+    "mkdocs-spellcheck[all]>=1.1.2",
+]
+
+[dependency-groups]
+dev = ["pre-commit-uv>=4.1.5"]