Skip to content

Commit ae9a5c2

Browse files
committed
chore: Template upgrade
1 parent 9c7e304 commit ae9a5c2

File tree

19 files changed

+362
-493
lines changed

19 files changed

+362
-493
lines changed

.copier-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 0.3.1
2+
_commit: 1.1.1
33
_src_path: gh:mkdocstrings/handler-template
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli

.github/FUNDING.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
github: pawamoy
22
ko_fi: pawamoy
3+
polar: pawamoy
34
custom:
45
- https://www.paypal.me/pawamoy

.github/workflows/ci.yml

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,6 @@ jobs:
4949
- name: Check if the code is correctly typed
5050
run: make check-types
5151

52-
- name: Check for vulnerabilities in dependencies
53-
run: make check-dependencies
54-
5552
- name: Check for breaking changes in the API
5653
run: make check-api
5754

@@ -69,10 +66,14 @@ jobs:
6966
{"python-version": "3.9"},
7067
{"python-version": "3.10"},
7168
{"python-version": "3.11"},
72-
{"python-version": "3.12"}
69+
{"python-version": "3.12"},
70+
{"python-version": "3.13"}
7371
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
7472
else
75-
echo 'jobs=[]' >> $GITHUB_OUTPUT
73+
echo 'jobs=[
74+
{"os": "macos-latest", "resolution": "lowest-direct"},
75+
{"os": "windows-latest", "resolution": "lowest-direct"}
76+
]' | tr -d '[:space:]' >> $GITHUB_OUTPUT
7677
fi
7778
7879
tests:
@@ -91,9 +92,13 @@ jobs:
9192
- "3.10"
9293
- "3.11"
9394
- "3.12"
95+
- "3.13"
96+
resolution:
97+
- highest
98+
- lowest-direct
9499
exclude: ${{ fromJSON(needs.exclude-test-jobs.outputs.jobs) }}
95100
runs-on: ${{ matrix.os }}
96-
continue-on-error: ${{ matrix.python-version == '3.12' }}
101+
continue-on-error: ${{ matrix.python-version == '3.13' }}
97102

98103
steps:
99104
- name: Checkout
@@ -109,10 +114,9 @@ jobs:
109114
run: pip install uv
110115

111116
- name: Install dependencies
112-
run: |
113-
uv venv
114-
uv pip install -r devdeps.txt
115-
uv pip install "mkdocstrings-python @ ."
117+
env:
118+
UV_RESOLUTION: ${{ matrix.resolution }}
119+
run: make setup
116120

117121
- name: Run the test suite
118122
run: make test

.gitignore

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,24 @@
1+
# editors
12
.idea/
23
.vscode/
3-
__pycache__/
4-
*.py[cod]
5-
dist/
4+
5+
# python
66
*.egg-info/
7-
build/
8-
htmlcov/
7+
*.py[cod]
8+
.venv/
9+
.venvs/
10+
/build/
11+
/dist/
12+
13+
# tools
914
.coverage*
10-
pip-wheel-metadata/
15+
/.pdm-build/
16+
/htmlcov/
17+
/site/
18+
19+
# cache
20+
.cache/
1121
.pytest_cache/
1222
.mypy_cache/
1323
.ruff_cache/
14-
site/
15-
.venv/
16-
.venvs/
17-
.cache/
24+
__pycache__/

Makefile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# This Makefile is just here to allow auto-completion in the terminal.
44

55
actions = \
6+
allrun \
67
changelog \
78
check \
89
check-api \
9-
check-dependencies \
1010
check-docs \
1111
check-quality \
1212
check-types \
@@ -16,6 +16,7 @@ actions = \
1616
docs-deploy \
1717
format \
1818
help \
19+
multirun \
1920
release \
2021
run \
2122
setup \

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<p align="center">A Python handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
44

55
[![ci](https://github.com/mkdocstrings/python/workflows/ci/badge.svg)](https://github.com/mkdocstrings/python/actions?query=workflow%3Aci)
6-
[![documentation](https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat)](https://mkdocstrings.github.io/python/)
6+
[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/python/)
77
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-python.svg)](https://pypi.org/project/mkdocstrings-python/)
8-
[![gitpod](https://img.shields.io/badge/gitpod-workspace-blue.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/python)
8+
[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/python)
99
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#python:gitter.im)
1010

1111
---

config/git-changelog.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,4 @@ parse-refs = false
66
parse-trailers = true
77
sections = ["build", "deps", "feat", "fix", "refactor"]
88
template = "keepachangelog"
9+
versioning = "pep440"

config/pytest.ini

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
[pytest]
22
python_files =
33
test_*.py
4-
*_test.py
5-
tests.py
64
addopts =
75
--cov
86
--cov-config config/coverage.ini

config/ruff.toml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ line-length = 120
33

44
[lint]
55
exclude = [
6-
"fixtures",
7-
"site",
6+
"tests/fixtures/*.py",
87
]
98
select = [
109
"A", "ANN", "ARG",
@@ -78,5 +77,8 @@ known-first-party = ["mkdocstrings_handlers.python"]
7877
convention = "google"
7978

8079
[format]
80+
exclude = [
81+
"tests/fixtures/*.py",
82+
]
8183
docstring-code-format = true
8284
docstring-code-line-length = 80

config/vscode/tasks.json

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,6 @@
3131
"command": "scripts/make",
3232
"args": ["check-docs"]
3333
},
34-
{
35-
"label": "check-dependencies",
36-
"type": "process",
37-
"command": "scripts/make",
38-
"args": ["check-dependencies"]
39-
},
4034
{
4135
"label": "check-api",
4236
"type": "process",

0 commit comments

Comments
 (0)