chore: Template upgrade

Author: pawamoy

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier.
-_commit: 1.8.4
+_commit: 1.11.1
 _src_path: gh:pawamoy/copier-uv
 author_email: dev@pawamoy.fr
 author_fullname: Timothée Mazzucotelli
@@ -8,7 +8,6 @@ copyright_date: '2025'
 copyright_holder: Timothée Mazzucotelli
 copyright_holder_email: dev@pawamoy.fr
 copyright_license: ISC
-insiders: false
 project_description: MkDocs plugin to generate an /llms.txt file.
 project_name: mkdocs-llmstxt
 python_package_command_line_name: ''

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+### For reviewers
+<!-- Help reviewers by letting them know whether AI was used to create this PR. -->
+
+- [ ] I did not use AI
+- [ ] I used AI and thoroughly reviewed every code/docs change
+
+### Description of the change
+<!-- Quick sentence for small changes, longer description for more impacting changes. -->
+
+### Relevant resources
+<!-- Link to any relevant GitHub issue, PR or discussion, section in online docs, etc. -->
+
+-
+-
+-

.github/workflows/ci.yml

@@ -2,10 +2,17 @@ name: ci
 
 on:
   push:
+    branches:
+    - main
+    - test-me-*
   pull_request:
     branches:
     - main
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.event_name == 'pull_request' }}
+
 defaults:
   run:
     shell: bash
@@ -14,13 +21,30 @@ env:
   LANG: en_US.utf-8
   LC_ALL: en_US.utf-8
   PYTHONIOENCODING: UTF-8
+  PYTHONWARNDEFAULTENCODING: "1"
   PYTHON_VERSIONS: ""
 
 jobs:
 
   quality:
+    strategy:
+      matrix:
+        os:
+        - ubuntu-latest
+        - macos-latest
+        - windows-latest
+        python-version:
+        - "3.10"
+        - "3.14"
+        include:
+        - os: ubuntu-latest
+          python-version: "3.11"
+        - os: ubuntu-latest
+          python-version: "3.12"
+        - os: ubuntu-latest
+          python-version: "3.13"
 
-    runs-on: ubuntu-latest
+    runs-on: ${{ matrix.os }}
 
     steps:
     - name: Checkout
@@ -33,9 +57,9 @@ jobs:
       uses: r-lib/actions/setup-pandoc@v2
 
     - name: Setup Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
-        python-version: "3.12"
+        python-version: ${{ matrix.python-version }}
 
     - name: Setup uv
       uses: astral-sh/setup-uv@v5
@@ -60,6 +84,7 @@ jobs:
 
     - name: Store objects inventory for tests
       uses: actions/upload-artifact@v4
+      if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' }}
       with:
         name: objects.inv
         path: site/objects.inv
@@ -75,12 +100,12 @@ jobs:
         - macos-latest
         - windows-latest
         python-version:
-        - "3.9"
         - "3.10"
         - "3.11"
         - "3.12"
         - "3.13"
         - "3.14"
+        - "3.15"
         resolution:
         - highest
         - lowest-direct
@@ -90,7 +115,7 @@ jobs:
         - os: windows-latest
           resolution: lowest-direct
     runs-on: ${{ matrix.os }}
-    continue-on-error: ${{ matrix.python-version == '3.14' }}
+    continue-on-error: true
 
     steps:
     - name: Checkout
@@ -103,7 +128,7 @@ jobs:
       uses: r-lib/actions/setup-pandoc@v2
 
     - name: Setup Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true

.github/workflows/release.yml

@@ -15,9 +15,9 @@ jobs:
         fetch-depth: 0
         fetch-tags: true
     - name: Setup Python
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
-        python-version: "3.12"
+        python-version: "3.13"
     - name: Setup uv
       uses: astral-sh/setup-uv@v5
     - name: Prepare release notes
@@ -26,3 +26,4 @@ jobs:
       uses: softprops/action-gh-release@v2
       with:
         body_path: release-notes.md
+

.github/workflows/sponsors.yml

@@ -0,0 +1,26 @@
+name: Update sponsors
+
+on:
+  schedule:
+  - cron: '0 0 * * *'
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  update-readme:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+    - name: Update README and create PR
+      uses: pawamoy/readme-insert@main
+      with:
+        markup-url: https://pawamoy.github.io/sponsors.txt
+        start-marker: '<!-- sponsors-start -->'
+        end-marker: '<!-- sponsors-end -->'
+        commit-message: 'chore: Update sponsors section in README'
+        pr-title: 'chore: Update sponsors section in README'
+        pr-body: 'This PR updates the sponsors section in the README file.'

Makefile

@@ -2,6 +2,13 @@
 # the `make` command will point at the `scripts/make` shell script.
 # This Makefile is just here to allow auto-completion in the terminal.
 
+default: help
+	@echo
+	@echo 'Enable direnv in your shell to use the `make` command: `direnv allow`'
+	@echo 'Or use `python scripts/make ARGS` to run the commands/tasks directly.'
+
+.DEFAULT_GOAL: default
+
 actions = \
 	allrun \
 	changelog \

README.md

@@ -3,7 +3,7 @@
 [![ci](https://github.com/pawamoy/mkdocs-llmstxt/workflows/ci/badge.svg)](https://github.com/pawamoy/mkdocs-llmstxt/actions?query=workflow%3Aci)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://pawamoy.github.io/mkdocs-llmstxt/)
 [![pypi version](https://img.shields.io/pypi/v/mkdocs-llmstxt.svg)](https://pypi.org/project/mkdocs-llmstxt/)
-[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#mkdocs-llmstxt:gitter.im)
+[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#mkdocs-llmstxt:gitter.im)
 
 MkDocs plugin to generate an [/llms.txt file](https://llmstxt.org/).
 
@@ -67,11 +67,11 @@ plugins:
 
 Use `base_url` to point `llms.txt` to documentation in a specific directory. For example, when using [Read the Docs](https://github.com/readthedocs/), use `base_url` to indicate the path to the hosted docs built for a specific language or version.
 
-The resulting `llms.txt` uses `base_url` when it is specified, instead of the canonical `site_url`.  
+The resulting `llms.txt` uses `base_url` when it is specified, instead of the canonical `site_url`.
 
 ```yaml title="mkdocs.yml"
 plugins:
-- llmstxt: 
+- llmstxt:
     base_url: https://productname.hostname.io/en/0.1.34
 ```
 
@@ -131,3 +131,8 @@ def preprocess(soup: BeautifulSoup, output: str) -> None:
 The `output` argument lets you modify the soup *depending on which file is being generated*.
 
 Have a look at [our own cleaning function](https://pawamoy.github.io/mkdocs-llmstxt/reference/api/#mkdocs_llmstxt.autoclean) to get inspiration.
+
+## Sponsors
+
+<!-- sponsors-start -->
+<!-- sponsors-end -->

config/pytest.ini

@@ -10,5 +10,7 @@ testpaths =
 # action:message_regex:warning_class:module_regex:line
 filterwarnings =
   error
+  default::EncodingWarning
+  error::EncodingWarning:mkdocs_llmstxt
   # TODO: remove once pytest-xdist 4 is released
   ignore:.*rsyncdir:DeprecationWarning:xdist

docs/.overrides/main.html

@@ -1,7 +1,11 @@
 {% extends "base.html" %}
 
 {% block announce %}
-  
+  <strong>Fund this project</strong> through
+  <a href="https://github.com/sponsors/pawamoy"><strong>sponsorship</strong></a>
+  <span class="twemoji heart pulse">
+    {% include ".icons/octicons/heart-fill-16.svg" %}
+  </span> &mdash;
   Follow
   <strong>@pawamoy</strong> on
   <a rel="me" href="https://fosstodon.org/@pawamoy">

duties.py

@@ -25,6 +25,8 @@
 WINDOWS = os.name == "nt"
 PTY = not WINDOWS and not CI
 MULTIRUN = os.environ.get("MULTIRUN", "0") == "1"
+PY_VERSION = f"{sys.version_info.major}{sys.version_info.minor}"
+PY_DEV = "314"
 
 
 def pyprefix(title: str) -> str:
@@ -68,7 +70,7 @@ def check(ctx: Context) -> None:
     """Check it all!"""
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_quality(ctx: Context) -> None:
     """Check the code quality."""
     ctx.run(
@@ -77,7 +79,7 @@ def check_quality(ctx: Context) -> None:
     )
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_docs(ctx: Context) -> None:
     """Check if the documentation builds correctly."""
     Path("htmlcov").mkdir(parents=True, exist_ok=True)
@@ -89,7 +91,7 @@ def check_docs(ctx: Context) -> None:
         )
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_types(ctx: Context) -> None:
     """Check that the code is correctly typed."""
     os.environ["FORCE_COLOR"] = "1"
@@ -99,7 +101,7 @@ def check_types(ctx: Context) -> None:
     )
 
 
-@duty
+@duty(nofail=PY_VERSION == PY_DEV)
 def check_api(ctx: Context, *cli_args: str) -> None:
     """Check for API breaking changes."""
     ctx.run(
@@ -132,7 +134,7 @@ def docs_deploy(ctx: Context) -> None:
     with material_insiders() as insiders:
         if not insiders:
             ctx.run(lambda: False, title="Not deploying docs without Material for MkDocs Insiders!")
-        ctx.run(tools.mkdocs.gh_deploy(), title="Deploying documentation")
+        ctx.run(tools.mkdocs.gh_deploy(force=True), title="Deploying documentation")
 
 
 @duty
@@ -179,7 +181,7 @@ def release(ctx: Context, version: str = "") -> None:
         ctx.run("false", title="A version must be provided")
     ctx.run("git add pyproject.toml CHANGELOG.md", title="Staging files", pty=PTY)
     ctx.run(["git", "commit", "-m", f"chore: Prepare release {version}"], title="Committing changes", pty=PTY)
-    ctx.run(f"git tag {version}", title="Tagging commit", pty=PTY)
+    ctx.run(f"git tag -m '' -a {version}", title="Tagging commit", pty=PTY)
     ctx.run("git push", title="Pushing commits", pty=False)
     ctx.run("git push --tags", title="Pushing tags", pty=False)
 
@@ -192,20 +194,15 @@ def coverage(ctx: Context) -> None:
     ctx.run(tools.coverage.html(rcfile="config/coverage.ini"))
 
 
-@duty
-def test(ctx: Context, *cli_args: str, match: str = "") -> None:  # noqa: PT028
-    """Run the test suite.
-
-    Parameters:
-        match: A pytest expression to filter selected tests.
-    """
-    py_version = f"{sys.version_info.major}{sys.version_info.minor}"
-    os.environ["COVERAGE_FILE"] = f".coverage.{py_version}"
+@duty(nofail=PY_VERSION == PY_DEV)
+def test(ctx: Context, *cli_args: str) -> None:
+    """Run the test suite."""
+    os.environ["COVERAGE_FILE"] = f".coverage.{PY_VERSION}"
+    os.environ["PYTHONWARNDEFAULTENCODING"] = "1"
     ctx.run(
         tools.pytest(
             "tests",
             config_file="config/pytest.ini",
-            select=match,
             color="yes",
         ).add_args("-n", "auto", *cli_args),
         title=pyprefix("Running tests"),