Skip to content

Commit ca303a2

Browse files
committed
chore: Template upgrade
1 parent 74388f1 commit ca303a2

29 files changed

+381
-417
lines changed

.copier-answers.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier.
2-
_commit: 1.9.0
2+
_commit: 1.11.12
33
_src_path: gh:pawamoy/copier-uv
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli
@@ -8,7 +8,6 @@ copyright_date: '2023'
88
copyright_holder: Timothée Mazzucotelli
99
copyright_holder_email: dev@pawamoy.fr
1010
copyright_license: ISC
11-
insiders: false
1211
project_description: Griffe extension for inheriting docstrings.
1312
project_name: Griffe Inherited Docstrings
1413
python_package_command_line_name: ''

.github/pull_request_template.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,11 @@
22
<!-- Help reviewers by letting them know whether AI was used to create this PR. -->
33

44
- [ ] I did not use AI
5-
- [ ] I used AI and thorougly reviewed every code/docs change
5+
- [ ] I used AI and thoroughly reviewed every code/docs change
66

77
### Description of the change
88
<!-- Quick sentence for small changes, longer description for more impacting changes. -->
99

10-
1110
### Relevant resources
1211
<!-- Link to any relevant GitHub issue, PR or discussion, section in online docs, etc. -->
1312

.github/workflows/ci.yml

Lines changed: 35 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,17 @@ name: ci
22

33
on:
44
push:
5+
branches:
6+
- main
7+
- test-me-*
58
pull_request:
69
branches:
710
- main
811

12+
concurrency:
13+
group: ${{ github.workflow }}-${{ github.ref }}
14+
cancel-in-progress: ${{ github.event_name == 'pull_request' }}
15+
916
defaults:
1017
run:
1118
shell: bash
@@ -14,13 +21,33 @@ env:
1421
LANG: en_US.utf-8
1522
LC_ALL: en_US.utf-8
1623
PYTHONIOENCODING: UTF-8
24+
PYTHONWARNDEFAULTENCODING: "1"
1725
PYTHON_VERSIONS: ""
1826

1927
jobs:
2028

2129
quality:
30+
strategy:
31+
matrix:
32+
os:
33+
- ubuntu-latest
34+
- macos-latest
35+
- windows-latest
36+
python-version:
37+
- "3.10"
38+
- "3.14"
39+
include:
40+
- os: ubuntu-latest
41+
python-version: "3.11"
42+
- os: ubuntu-latest
43+
python-version: "3.12"
44+
- os: ubuntu-latest
45+
python-version: "3.13"
46+
- os: ubuntu-latest
47+
python-version: "3.15-dev"
2248

23-
runs-on: ubuntu-latest
49+
runs-on: ${{ matrix.os }}
50+
continue-on-error: true
2451

2552
steps:
2653
- name: Checkout
@@ -30,9 +57,9 @@ jobs:
3057
fetch-tags: true
3158

3259
- name: Setup Python
33-
uses: actions/setup-python@v5
60+
uses: actions/setup-python@v6
3461
with:
35-
python-version: "3.12"
62+
python-version: ${{ matrix.python-version }}
3663

3764
- name: Setup uv
3865
uses: astral-sh/setup-uv@v5
@@ -57,6 +84,7 @@ jobs:
5784

5885
- name: Store objects inventory for tests
5986
uses: actions/upload-artifact@v4
87+
if: ${{ matrix.os == 'ubuntu-latest' && matrix.python-version == '3.13' }}
6088
with:
6189
name: objects.inv
6290
path: site/objects.inv
@@ -72,12 +100,12 @@ jobs:
72100
- macos-latest
73101
- windows-latest
74102
python-version:
75-
- "3.9"
76103
- "3.10"
77104
- "3.11"
78105
- "3.12"
79106
- "3.13"
80107
- "3.14"
108+
- "3.15-dev"
81109
resolution:
82110
- highest
83111
- lowest-direct
@@ -86,8 +114,9 @@ jobs:
86114
resolution: lowest-direct
87115
- os: windows-latest
88116
resolution: lowest-direct
117+
89118
runs-on: ${{ matrix.os }}
90-
continue-on-error: ${{ matrix.python-version == '3.14' }}
119+
continue-on-error: true
91120

92121
steps:
93122
- name: Checkout
@@ -97,7 +126,7 @@ jobs:
97126
fetch-tags: true
98127

99128
- name: Setup Python
100-
uses: actions/setup-python@v5
129+
uses: actions/setup-python@v6
101130
with:
102131
python-version: ${{ matrix.python-version }}
103132
allow-prereleases: true

.github/workflows/release.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ jobs:
1515
fetch-depth: 0
1616
fetch-tags: true
1717
- name: Setup Python
18-
uses: actions/setup-python@v5
18+
uses: actions/setup-python@v6
1919
with:
20-
python-version: "3.12"
20+
python-version: "3.13"
2121
- name: Setup uv
2222
uses: astral-sh/setup-uv@v5
2323
- name: Prepare release notes
@@ -26,3 +26,4 @@ jobs:
2626
uses: softprops/action-gh-release@v2
2727
with:
2828
body_path: release-notes.md
29+

.github/workflows/sponsors.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Update sponsors
2+
3+
on:
4+
schedule:
5+
- cron: '0 0 * * *'
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: write
10+
pull-requests: write
11+
12+
jobs:
13+
update-readme:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout repository
17+
uses: actions/checkout@v4
18+
- name: Update README and create PR
19+
uses: pawamoy/readme-insert@main
20+
with:
21+
markup-url: https://pawamoy.github.io/sponsors.txt
22+
start-marker: '<!-- sponsors-start -->'
23+
end-marker: '<!-- sponsors-end -->'
24+
commit-message: 'chore: Update sponsors section in README'
25+
pr-title: 'chore: Update sponsors section in README'
26+
pr-body: 'This PR updates the sponsors section in the README file.'

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,5 @@ uv.lock
2020
# cache
2121
.cache/
2222
.pytest_cache/
23-
.mypy_cache/
2423
.ruff_cache/
2524
__pycache__/

CONTRIBUTING.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,7 @@ Run `make help` to see all the available actions!
2929
3030
## Tasks
3131
32-
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,
33-
while the *tasks* do. The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
32+
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).
3433
3534
If you work in VSCode, we provide [an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup) for the project.
3635

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Griffe Inherited Docstrings
22

33
[![ci](https://github.com/mkdocstrings/griffe-inherited-docstrings/workflows/ci/badge.svg)](https://github.com/mkdocstrings/griffe-inherited-docstrings/actions?query=workflow%3Aci)
4-
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)
4+
[![documentation](https://img.shields.io/badge/docs-zensical-FF9100.svg?style=flat)](https://mkdocstrings.github.io/griffe-inherited-docstrings/)
55
[![pypi version](https://img.shields.io/pypi/v/griffe-inherited-docstrings.svg)](https://pypi.org/project/griffe-inherited-docstrings/)
66
[![gitter](https://img.shields.io/badge/matrix-chat-4DB798.svg?style=flat)](https://app.gitter.im/#/room/#griffe-inherited-docstrings:gitter.im)
77

@@ -86,3 +86,8 @@ Class | Method docstring
8686

8787
WARNING: **Limitation**
8888
This extension runs once on whole packages. There is no way to toggle merging or simple inheritance for specifc objects.
89+
90+
## Sponsors
91+
92+
<!-- sponsors-start -->
93+
<!-- sponsors-end -->

config/mypy.ini

Lines changed: 0 additions & 5 deletions
This file was deleted.

config/pytest.ini

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,7 @@ testpaths =
1010
# action:message_regex:warning_class:module_regex:line
1111
filterwarnings =
1212
error
13+
default::EncodingWarning
14+
error::EncodingWarning:griffe_inherited_docstrings
1315
# TODO: remove once pytest-xdist 4 is released
1416
ignore:.*rsyncdir:DeprecationWarning:xdist

0 commit comments

Comments
 (0)