Skip to content

Commit 6a53155

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent 277af0f commit 6a53155

23 files changed

Lines changed: 425 additions & 465 deletions

File tree

‎.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: 1.1.0
2+
_commit: 1.1.4
33
_src_path: gh:mkdocstrings/handler-template
44
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli

.github/ISSUE_TEMPLATE/bug_report.md renamed to .github/ISSUE_TEMPLATE/1-bug.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ PASTE TRACEBACK HERE
5353
python -m mkdocstrings_handlers.typescript.debug # | xclip -selection clipboard
5454
```
5555

56-
PASTE OUTPUT HERE
56+
PASTE MARKDOWN OUTPUT HERE
5757

5858
### Additional context
5959
<!-- Add any other relevant context about the problem here,

.github/ISSUE_TEMPLATE/feature_request.md renamed to .github/ISSUE_TEMPLATE/2-feature.md

File renamed without changes.

‎.github/ISSUE_TEMPLATE/3-docs.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Documentation update
3+
about: Point at unclear, missing or outdated documentation.
4+
title: "docs: "
5+
labels: docs
6+
assignees: pawamoy
7+
---
8+
9+
### Is something unclear, missing or outdated in our documentation?
10+
<!-- A clear and concise description of what the documentation issue is. Ex. I can't find an explanation on feature [...]. -->
11+
12+
### Relevant code snippets
13+
<!-- If the documentation issue is related to code, please provide relevant code snippets. -->
14+
15+
### Link to the relevant documentation section
16+
<!-- Add a link to the relevant section of our documentation, or any addition context. -->

‎.github/ISSUE_TEMPLATE/4-change.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: Change request
3+
about: Suggest any other kind of change for this project.
4+
title: "change: "
5+
assignees: pawamoy
6+
---
7+
8+
### Is your change request related to a problem? Please describe.
9+
<!-- A clear and concise description of what the problem is. -->
10+
11+
### Describe the solution you'd like
12+
<!-- A clear and concise description of what you want to happen. -->
13+
14+
### Describe alternatives you've considered
15+
<!-- A clear and concise description of any alternative solutions you've considered. -->
16+
17+
### Additional context
18+
<!-- Add any other context or screenshots about the change request here. -->

‎.github/workflows/ci.yml‎

Lines changed: 0 additions & 3 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

‎CONTRIBUTING.md‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -36,13 +36,11 @@ Run `make help` to see all the available actions!
3636
3737
## Tasks
3838
39-
This project uses [duty](https://github.com/pawamoy/duty) to run tasks.
40-
A Makefile is also provided. The Makefile will try to run certain tasks
41-
on multiple Python versions. If for some reason you don't want to run the task
42-
on multiple Python versions, you run the task directly with `make run duty TASK`.
43-
44-
The Makefile detects if a virtual environment is activated,
45-
so `make` will work the same with the virtualenv activated or not.
39+
The entry-point to run commands and tasks is the `make` Python script,
40+
located in the `scripts` directory. Try running `make` to show the available commands and tasks.
41+
The *commands* do not need the Python dependencies to be installed,
42+
while the *tasks* do.
43+
The cross-platform tasks are written in Python, thanks to [duty](https://github.com/pawamoy/duty).
4644
4745
If you work in VSCode, we provide
4846
[an action to configure VSCode](https://pawamoy.github.io/copier-uv/work/#vscode-setup)

‎Makefile‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ actions = \
77
changelog \
88
check \
99
check-api \
10-
check-dependencies \
1110
check-docs \
1211
check-quality \
1312
check-types \
@@ -26,4 +25,4 @@ actions = \
2625

2726
.PHONY: $(actions)
2827
$(actions):
29-
@bash scripts/make "$@"
28+
@python scripts/make "$@"

‎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/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)