Merge branch 'main' of github.com:pawamoy/copier-uv

Author: pawamoy

.github/workflows/ci.yml

@@ -41,9 +41,9 @@ jobs:
       with:
         python-version: "3.12"
     - name: Setup uv
-      uses: astral-sh/setup-uv@v3
+      uses: astral-sh/setup-uv@v5
     - name: Test licenses
-      run: uv run --with jinja2 python tests/test_licenses.py
+      run: uv run --with jinja2 --with pyyaml --with reuse python tests/test_licenses.py
 
   test-project:
     strategy:
@@ -75,19 +75,18 @@ jobs:
         git config --global init.defaultBranch main
         git config --global user.email "dev@pawamoy.fr"
         git config --global user.name "Timothée Mazzucotelli"
-  
+
     - name: Setup Python
       uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true
 
     - name: Setup uv
-      uses: astral-sh/setup-uv@v3
+      uses: astral-sh/setup-uv@v5
       with:
         enable-cache: true
         cache-dependency-glob: project/pyproject.toml.jinja
-        cache-suffix: py${{ matrix.python-version }}
 
     - name: Install Copier
       env:

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       with:
         python-version: "3.12"
     - name: Setup uv
-      uses: astral-sh/setup-uv@v3
+      uses: astral-sh/setup-uv@v5
     - name: Prepare release notes
       run: uv tool run git-changelog --release-notes > release-notes.md
     - name: Create release

CHANGELOG.md

@@ -6,9 +6,51 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 <!-- insertion marker -->
-## [1.2.4](https://github.com/pawamoy/copier-uv/releases/tag/1.2.4) - 2025-01-23
+## [1.3.0](https://github.com/mkdocstrings/handler-template/releases/tag/1.3.0) - 2025-03-11
 
-<small>[Compare with 1.5.6](https://github.com/pawamoy/copier-uv/compare/1.2.3...1.2.4)</small>
+<small>[Compare with 1.2.4](https://github.com/mkdocstrings/handler-template/compare/1.2.4...1.3.0)</small>
+
+### Merge upstream
+
+#### Features
+
+- Enable backlinks in API docs ([20aba08](https://github.com/pawamoy/copier-uv/commit/20aba086f2bfe7939bedce9d0fa457a19089159a) by Timothée Mazzucotelli).
+- Check legacy code with Yore each time the changelog is updated ([63e4af5](https://github.com/pawamoy/copier-uv/commit/63e4af5bd318c1625e4f51e9a5d24a7b941d7277) by Timothée Mazzucotelli). [Issue-60](https://github.com/pawamoy/copier-uv/issues/60)
+- Split dependency-groups in sections ([bae928e](https://github.com/pawamoy/copier-uv/commit/bae928ece555c14ac8eae8e1ad4b7c0d6f98faf0) by Dennis Bücker). [Discussion-58](https://github.com/pawamoy/copier-uv/discussions/58), [PR-59](https://github.com/pawamoy/copier-uv/pull/59)
+- Generate /llms.txt docs file ([2000ef6](https://github.com/pawamoy/copier-uv/commit/2000ef688cc75e71140a6acecf9fd918ee9210b6) by Timothée Mazzucotelli). [Issue-49](https://github.com/pawamoy/copier-uv/issues/49)
+- Add initial API tests ([997155b](https://github.com/pawamoy/copier-uv/commit/997155b69ba48d397433582127302696c08dbb0e) by Timothée Mazzucotelli).
+- Add config to run project, and allow to pass arguments ([bd88519](https://github.com/pawamoy/copier-uv/commit/bd8851921c7105aa523867e7f64a217a562a5a41) by Timothée Mazzucotelli). [Issue-53](https://github.com/pawamoy/copier-uv/issues/53)
+
+#### Bug Fixes
+
+- Output llms-full.txt, not llms.txt ([2c8b4f8](https://github.com/pawamoy/copier-uv/commit/2c8b4f8d55d7e66d8c14c0ec897828d065969fb5) by Timothée Mazzucotelli).
+- Ensure test jobs wait for quality one (for objects inventory artifact to be ready) ([885f204](https://github.com/pawamoy/copier-uv/commit/885f204f5b32b43099193cd2f7cc62e4011f39b0) by Timothée Mazzucotelli).
+- Fix license choices in template configuration ([f26c221](https://github.com/pawamoy/copier-uv/commit/f26c22184aa6326f94a6722dc818b7364e8bb8bc) by Timothée Mazzucotelli).
+- Prevent extension crash with key error ([1d27caf](https://github.com/pawamoy/copier-uv/commit/1d27caf9d79919c1e4d97cb312b19e80bc947d59) by Timothée Mazzucotelli).
+
+#### Code Refactoring
+
+- Fully enable autorefs for docs ([152924d](https://github.com/pawamoy/copier-uv/commit/152924dcc5b8238f016abe89297a6402ec779bd8) by Timothée Mazzucotelli).
+- Simplify API docs (stop using gen-files and literate-nav) ([6d1aec8](https://github.com/pawamoy/copier-uv/commit/6d1aec8c12673b10192903f584d40ddc94741dbf) by Timothée Mazzucotelli).
+- Stop depending on Black now that mkdocstrings-python supports Ruff for formatting signatures ([6554451](https://github.com/pawamoy/copier-uv/commit/65544511a65dc075157ee3f3686882108e93ed6d) by Timothée Mazzucotelli).
+- Store and download objects inventory in CI, enabling API tests ([a55906c](https://github.com/pawamoy/copier-uv/commit/a55906c88042e454547af8a5ee0e946e3ef57d6e) by Timothée Mazzucotelli).
+- Prevent publishing insiders packages to PyPI ([b51ae0f](https://github.com/pawamoy/copier-uv/commit/b51ae0f48257a83279e97a7adb2c6a240139383b) by Timothée Mazzucotelli). [Issue-44](https://github.com/pawamoy/copier-uv/issues/44)
+- Mention `insiders` instead of `pypi-insiders` in docs ([4c8d09e](https://github.com/pawamoy/copier-uv/commit/4c8d09e914b4e88d9522f4aafb37b9aabd22c780) by Timothée Mazzucotelli). [Issue-45](https://github.com/pawamoy/copier-uv/issues/45)
+- Write comments, not docstrings in internal modules/scripts ([bedf879](https://github.com/pawamoy/copier-uv/commit/bedf8796b76b215c5d228d6b76f5fa22c7a0eddc) by Timothée Mazzucotelli).
+- Use an "internal" layout ([fd500cc](https://github.com/pawamoy/copier-uv/commit/fd500cc25be5b0a169153b08b0715a5c21715f00) by Timothée Mazzucotelli). [Issue-50](https://github.com/pawamoy/copier-uv/issues/50)
+- Remove Ko-Fi and Paypal from funding file ([16f0e0e](https://github.com/pawamoy/copier-uv/commit/16f0e0e8e48bbf8ec7ac1864f3bf54271faab9c0) by Timothée Mazzucotelli). [Issue-55](https://github.com/pawamoy/copier-uv/issues/55)
+- Update setup-uv action version ([52df1c1](https://github.com/pawamoy/copier-uv/commit/52df1c14eed14bc08a3e5d6cb92112376c44d136) by Timothée Mazzucotelli). [Issue-54](https://github.com/pawamoy/copier-uv/issues/54)
+- Enable docs instant preview (link hover) ([59b1229](https://github.com/pawamoy/copier-uv/commit/59b12297d085aeac5d7187c5f2c98e91ce60ba7e) by Timothée Mazzucotelli). [Issue-52](https://github.com/pawamoy/copier-uv/issues/52)
+- Rename mkdocstrings-python `import` option to `inventories` ([c56d1cc](https://github.com/pawamoy/copier-uv/commit/c56d1cc58f4fc357582ee4e17885c11f53e5c200) by Timothée Mazzucotelli).
+- Enable docs navigation breadcrumbs ([15536d7](https://github.com/pawamoy/copier-uv/commit/15536d76e5482bd4ec9738345142e13e5b91f953) by Timothée Mazzucotelli).
+- Rename script that generates API reference ([db1a856](https://github.com/pawamoy/copier-uv/commit/db1a856081b5d0540ad3823cb54299191722c6b7) by Timothée Mazzucotelli).
+- Set metadata title in docs pages ([1837a07](https://github.com/pawamoy/copier-uv/commit/1837a07b751964de44631211dbfa7154ec33a547) by Timothée Mazzucotelli).
+- Update license templating ([84537c7](https://github.com/pawamoy/copier-uv/commit/84537c7ea157c9f5876f626e4a7d92619348a915) by Timothée Mazzucotelli).
+- Update insiders docs now that we better handle beneficiaries ([59bbbb5](https://github.com/pawamoy/copier-uv/commit/59bbbb5334ce0362537e0737df6e38d73f461339) by Timothée Mazzucotelli).
+
+## [1.2.4](https://github.com/mkdocstrings/handler-template/releases/tag/1.2.4) - 2025-01-23
+
+<small>[Compare with 1.5.6](https://github.com/mkdocstrings/handler-template/compare/1.2.3...1.2.4)</small>
 
 ### Merge upstream
 

copier.yml

@@ -81,41 +81,41 @@ copyright_date:
 copyright_license:
   type: str
   help: Your project's license
-  default: ISC License
+  default: ISC
   choices:
-  - Academic Free License v3.0
-  - Apache License 2.0
-  - Artistic License 2.0
-  - BSD 2-Clause "Simplified" License
-  - BSD 3-Clause Clear License
-  - BSD 3-Clause "New" or "Revised" License
-  - Boost Software License 1.0
-  - Creative Commons Attribution 4.0
-  - Creative Commons Attribution Share Alike 4.0
-  - Creative Commons Zero v1.0 Universal
-  - Do What The F*ck You Want To Public License
-  - Educational Community License v2.0
-  - Eclipse Public License 1.0
-  - Eclipse Public License 2.0
-  - European Union Public License 1.1
-  - European Union Public License 1.2
-  - GNU Affero General Public License v3.0
-  - GNU General Public License v2.0
-  - GNU General Public License v3.0
-  - GNU Lesser General Public License v2.1
-  - GNU Lesser General Public License v3.0
-  - ISC License
-  - LaTeX Project Public License v1.3c
-  - MIT License
-  - Mozilla Public License 2.0
-  - Microsoft Public License
-  - Microsoft Reciprocal License
-  - University of Illinois/NCSA Open Source License
-  - SIL Open Font License 1.1
-  - Open Software License 3.0
-  - PostgreSQL License
-  - The Unlicense
-  - zlib License
+    Academic Free License v3.0: AFL-3.0
+    Apache License 2.0: Apache-2.0
+    Artistic License 2.0: Artistic-2.0
+    BSD 2-Clause "Simplified" License: BSD-2-Clause
+    BSD 3-Clause Clear License: BSD-3-Clause-Clear
+    BSD 3-Clause "New" or "Revised" License: BSD-3-Clause
+    Boost Software License 1.0: BSL-1.0
+    Creative Commons Attribution 4.0 International: CC-BY-4.0
+    Creative Commons Attribution Share Alike 4.0 International: CC-BY-SA-4.0
+    Creative Commons Zero v1.0 Universal: CC0-1.0
+    Do What The F*ck You Want To Public License: WTFPL
+    Educational Community License v2.0: ECL-2.0
+    Eclipse Public License 1.0: EPL-1.0
+    Eclipse Public License 2.0: EPL-2.0
+    European Union Public License 1.1: EUPL-1.1
+    European Union Public License 1.2: EUPL-1.2
+    GNU Affero General Public License v3.0: AGPL-3.0
+    GNU General Public License v2.0 only: GPL-2.0
+    GNU General Public License v3.0 only: GPL-3.0
+    GNU Lesser General Public License v2.1 only: LGPL-2.1
+    GNU Lesser General Public License v3.0 only: LGPL-3.0
+    ISC License: ISC
+    LaTeX Project Public License v1.3c: LPPL-1.3c
+    MIT License: MIT
+    Mozilla Public License 2.0: MPL-2.0
+    Microsoft Public License: MS-PL
+    Microsoft Reciprocal License: MS-RL
+    University of Illinois/NCSA Open Source License: NCSA
+    SIL Open Font License 1.1: OFL-1.1
+    Open Software License 3.0: OSL-3.0
+    PostgreSQL License: PostgreSQL
+    The Unlicense: Unlicense
+    zlib License: Zlib
 
 python_package_distribution_name:
   type: str

extensions.py

@@ -46,7 +46,7 @@ class GitHubIDsforGiscusExtension(ContextHook):
     repo_placeholder = "REPLACE WITH REPOSITORY NODE ID"
     category_placeholder = "REPLACE WITH DISCUSSION CATEGORY ID"
     update = False
-    query = """                     
+    query = """
     {
         repository(owner: "%(owner)s", name: "%(name)s") {
             discussionCategories(first: 100) {
@@ -63,8 +63,11 @@ class GitHubIDsforGiscusExtension(ContextHook):
     category_id: str | None = None
 
     def hook(self, context):
-        repository_namespace = context["repository_namespace"]
-        repository_name = context["repository_name"]
+        try:
+            repository_namespace = context["repository_namespace"]
+            repository_name = context["repository_name"]
+        except KeyError:
+            return
 
         if self.repo_id is None:
             command = f"gh api repos/{repository_namespace}/{repository_name} --jq .node_id"

project/.envrc project/.envrc.jinjaproject/.envrc renamed to project/.envrc.jinja

@@ -1,5 +1,2 @@
 github: {{ author_username }}
-ko_fi: {{ author_username }}
 polar: {{ author_username }}
-custom:
-- https://www.paypal.me/{{ author_username }}

project/.github/FUNDING.yml.jinja

@@ -51,7 +51,7 @@ PASTE TRACEBACK HERE
 
 ```bash
 {% if python_package_command_line_name %}{{ python_package_command_line_name }} --debug-info
-{%- else %}python -m mkdocstrings_handlers.{{ python_package_import_name }}.debug{% endif %}  # | xclip -selection clipboard
+{%- else %}python -m mkdocstrings_handlers.{{ python_package_import_name }}._internal.debug{% endif %}  # | xclip -selection clipboard
 ```
 
 PASTE MARKDOWN OUTPUT HERE