chore: Template upgrade

pawamoy · pawamoy · commit 7abf89d18e2a · 2024-08-15T13:05:23.000+02:00
diff --git a/.copier-answers.yml b/.copier-answers.yml
@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier
-_commit: 1.1.0
+_commit: 1.4.0
 _src_path: gh:pawamoy/copier-uv
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli
diff --git a/.github/ISSUE_TEMPLATE/1-bug.md b/.github/ISSUE_TEMPLATE/1-bug.md
@@ -53,7 +53,7 @@ PASTE TRACEBACK HERE
 python -m griffe_inherited_docstrings.debug  # | xclip -selection clipboard
 ```
 
-PASTE OUTPUT HERE
+PASTE MARKDOWN OUTPUT HERE
 
 ### Additional context
 <!-- Add any other relevant context about the problem here,
diff --git a/.github/ISSUE_TEMPLATE/2-feature.md b/.github/ISSUE_TEMPLATE/2-feature.md
diff --git a/.github/ISSUE_TEMPLATE/3-docs.md b/.github/ISSUE_TEMPLATE/3-docs.md
@@ -0,0 +1,16 @@
+---
+name: Documentation update
+about: Point at unclear, missing or outdated documentation.
+title: "docs: "
+labels: docs
+assignees: pawamoy
+---
+
+### Is something unclear, missing or outdated in our documentation?
+<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. -->
+
+### Relevant code snippets
+<!-- If the documentation issue is related to code, please provide relevant code snippets. -->
+
+### Link to the relevant documentation section
+<!-- Add a link to the relevant section of our documentation, or any addition context. -->
diff --git a/.github/ISSUE_TEMPLATE/4-change.md b/.github/ISSUE_TEMPLATE/4-change.md
@@ -0,0 +1,18 @@
+---
+name: Change request
+about: Suggest any other kind of change for this project.
+title: "change: "
+assignees: pawamoy
+---
+
+### Is your change request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. -->
+
+### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
+
+### Describe alternatives you've considered
+<!-- A clear and concise description of any alternative solutions you've considered. -->
+
+### Additional context
+<!-- Add any other context or screenshots about the change request here. -->
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -49,9 +49,6 @@ jobs:
     - name: Check if the code is correctly typed
       run: make check-types
 
-    - name: Check for vulnerabilities in dependencies
-      run: make check-dependencies
-
     - name: Check for breaking changes in the API
       run: make check-api
 
@@ -69,8 +66,17 @@ jobs:
         - "3.10"
         - "3.11"
         - "3.12"
+        - "3.13"
+        resolution:
+        - highest
+        - lowest-direct
+        exclude:
+        - os: macos-latest
+          resolution: lowest-direct
+        - os: windows-latest
+          resolution: lowest-direct
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.python-version == '3.12' }}
+    continue-on-error: ${{ matrix.python-version == '3.13' }}
 
     steps:
     - name: Checkout
@@ -86,6 +92,8 @@ jobs:
       run: pip install uv
 
     - name: Install dependencies
+      env:
+        UV_RESOLUTION: ${{ matrix.resolution }}
       run: make setup
 
     - name: Run the test suite
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -36,13 +36,11 @@ Run `make help` to see all the available actions!
 
 ## Tasks
 
-This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
-A Makefile is also provided. The Makefile will try to run certain tasks
-on multiple Python versions. If for some reason you don't want to run the task
-on multiple Python versions, you run the task directly with `make run duty TASK`.
-
-The Makefile detects if a virtual environment is activated,
-so `make` will work the same with the virtualenv activated or not.
+The entry-point to run commands and tasks is the `make` Python script,
+located in the `scripts` directory. Try running `make` to show the available commands and tasks.
+The *commands* do not need the Python dependencies to be installed,
+while the *tasks* do.
+The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
 
 If you work in VSCode, we provide
 [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)
diff --git a/Makefile b/Makefile
@@ -3,10 +3,10 @@
 # This Makefile is just here to allow auto-completion in the terminal.
 
 actions = \
+	allrun \
 	changelog \
 	check \
 	check-api \
-	check-dependencies \
 	check-docs \
 	check-quality \
 	check-types \
@@ -16,6 +16,7 @@ actions = \
 	docs-deploy \
 	format \
 	help \
+	multirun \
 	release \
 	run \
 	setup \
@@ -24,4 +25,4 @@ actions = \
 
 .PHONY: $(actions)
 $(actions):
-	@bash scripts/make "$@"
+	@python scripts/make "$@"
diff --git a/README.md b/README.md
@@ -1,9 +1,9 @@
 # Griffe Inherited Docstrings
 
 [![ci](https://github.com/mkdocstrings/griffe-inherited-docstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-inherited-docstrings/actions?query=workflow%3Aci)
-[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)
+[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)
 [![pypi version](https://img.shields.io/pypi/v/griffe-inherited-docstrings.svg)](https://pypi.org/project/griffe-inherited-docstrings/)
-[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-inherited-docstrings)
+[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-inherited-docstrings)
 [![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-inherited-docstrings:gitter.im)
 
 Griffe extension for inheriting docstrings.
diff --git a/config/git-changelog.toml b/config/git-changelog.toml
@@ -6,3 +6,4 @@ parse-refs = false
 parse-trailers = true
 sections = ["build", "deps", "feat", "fix", "refactor"]
 template = "keepachangelog"
+versioning = "pep440"
diff --git a/config/pytest.ini b/config/pytest.ini
@@ -1,8 +1,6 @@
 [pytest]
 python_files =
   test_*.py
-  *_test.py
-  tests.py
 addopts =
   --cov
   --cov-config config/coverage.ini
diff --git a/config/vscode/tasks.json b/config/vscode/tasks.json
@@ -31,12 +31,6 @@
             "command": "scripts/make",
             "args": ["check-docs"]
         },
-        {
-            "label": "check-dependencies",
-            "type": "process",
-            "command": "scripts/make",
-            "args": ["check-dependencies"]
-        },
         {
             "label": "check-api",
             "type": "process",
diff --git a/devdeps.txt b/devdeps.txt
@@ -1,27 +1,32 @@
-build>=1.0
-duty>=0.10
-black>=23.9
-markdown-callouts>=0.3
-markdown-exec>=1.7
-mkdocs>=1.5
+# dev
+editables>=0.5
+
+# maintenance
+build>=1.2
+git-changelog>=2.5
+twine>=5.0; python_version < '3.13'
+
+# ci
+duty>=1.4
+ruff>=0.4
+pytest>=8.2
+pytest-cov>=5.0
+pytest-randomly>=3.15
+pytest-xdist>=3.6
+mypy>=1.10
+types-markdown>=3.6
+types-pyyaml>=6.0
+
+# docs
+black>=24.4
+markdown-callouts>=0.4
+markdown-exec>=1.8
+mkdocs>=1.6
 mkdocs-coverage>=1.0
 mkdocs-gen-files>=0.5
-mkdocs-git-committers-plugin-2>=1.2
+mkdocs-git-committers-plugin-2>=2.3
 mkdocs-literate-nav>=0.6
-mkdocs-material>=9.4
-mkdocs-minify-plugin>=0.7
-mkdocstrings[python]>=0.23
+mkdocs-material>=9.5
+mkdocs-minify-plugin>=0.8
+mkdocstrings[python]>=0.25
 tomli>=2.0; python_version < '3.11'
-black>=23.9
-blacken-docs>=1.16
-git-changelog>=2.3
-ruff>=0.0
-pytest>=7.4
-pytest-cov>=4.1
-pytest-randomly>=3.15
-pytest-xdist>=3.3
-mypy>=1.5
-types-markdown>=3.5
-types-pyyaml>=6.0
-safety>=2.3
-twine>=5.0
diff --git a/docs/.overrides/main.html b/docs/.overrides/main.html
@@ -2,11 +2,13 @@
 
 {% block announce %}
   
-  For updates follow <strong>@pawamoy</strong> on
+  Follow
+  <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">
     <span class="twemoji mastodon">
       {% include ".icons/fontawesome/brands/mastodon.svg" %}
     </span>
     <strong>Fosstodon</strong>
   </a>
+  for updates
 {% endblock %}
diff --git a/docs/.overrides/partials/comments.html b/docs/.overrides/partials/comments.html
@@ -0,0 +1,57 @@
+<!-- Giscus -->
+<!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration -->
+<div id="feedback" style="display: none;">
+    <h2 id="__comments">Feedback</h2>
+    <script src="https://giscus.app/client.js"
+        data-repo="mkdocstrings/griffe-inherited-docstrings"
+        data-repo-id="R_kgDOKi9yRg"
+        data-category="Documentation"
+        data-category-id="DIC_kwDOKi9yRs4Chq2F"
+        data-mapping="pathname"
+        data-strict="1"
+        data-reactions-enabled="0"
+        data-emit-metadata="0"
+        data-input-position="top"
+        data-theme="preferred_color_scheme"
+        data-lang="en"
+        data-loading="lazy"
+        crossorigin="anonymous"
+        async>
+    </script>
+
+    <!-- Synchronize Giscus theme with palette -->
+    <script>
+        var giscus = document.querySelector("script[src*=giscus]")
+
+        // Set palette on initial load
+        var palette = __md_get("__palette")
+        if (palette && typeof palette.color === "object") {
+            var theme = palette.color.scheme === "slate"
+                ? "transparent_dark"
+                : "light"
+
+            // Instruct Giscus to set theme
+            giscus.setAttribute("data-theme", theme) 
+        }
+
+        // Register event handlers after documented loaded
+        document.addEventListener("DOMContentLoaded", function() {
+            var ref = document.querySelector("[data-md-component=palette]")
+            ref.addEventListener("change", function() {
+                var palette = __md_get("__palette")
+                if (palette && typeof palette.color === "object") {
+                    var theme = palette.color.scheme === "slate"
+                        ? "transparent_dark"
+                        : "light"
+
+                    // Instruct Giscus to change theme
+                    var frame = document.querySelector(".giscus-frame")
+                    frame.contentWindow.postMessage(
+                        { giscus: { setConfig: { theme } } },
+                        "https://giscus.app"
+                    )
+                }
+            })
+        })
+    </script>
+</div>
diff --git a/docs/css/mkdocstrings.css b/docs/css/mkdocstrings.css
@@ -18,7 +18,7 @@ a.autorefs-external::after {
 
   height: 1em;
   width: 1em;
-  background-color: var(--md-typeset-a-color);
+  background-color: currentColor;
 }
 
 a.external:hover::after,
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1,6 @@
+---
+hide:
+- feedback
+---
+
 --8<-- "README.md"
diff --git a/docs/js/feedback.js b/docs/js/feedback.js
@@ -0,0 +1,14 @@
+const feedback = document.forms.feedback;
+feedback.hidden = false;
+
+feedback.addEventListener("submit", function(ev) {
+    ev.preventDefault();
+    const commentElement = document.getElementById("feedback");
+    commentElement.style.display = "block";
+    feedback.firstElementChild.disabled = true;
+    const data = ev.submitter.getAttribute("data-md-value");
+    const note = feedback.querySelector(".md-feedback__note [data-md-value='" + data + "']");
+    if (note) {
+        note.hidden = false;
+    }
+})
diff --git a/docs/license.md b/docs/license.md
@@ -1,3 +1,8 @@
+---
+hide:
+- feedback
+---
+
 # License
 
 ```
diff --git a/duties.py b/duties.py
diff --git a/mkdocs.yml b/mkdocs.yml
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/scripts/gen_credits.py b/scripts/gen_credits.py
diff --git a/scripts/gen_ref_nav.py b/scripts/gen_ref_nav.py
diff --git a/scripts/make b/scripts/make
