Skip to content

Commit 6a53155

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

File tree

23 files changed

+425
-465
lines changed

23 files changed

+425
-465
lines changed

‎.copier-answers.yml

+1-1
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

+1-1
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

+16
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

+18
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

-3
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

+5-7
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

+1-2
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

-2
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

-6
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",

‎devdeps.txt

+19-20
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,31 @@
22
editables>=0.5
33

44
# maintenance
5-
build>=1.0
6-
git-changelog>=2.3
7-
twine>=5.0
5+
build>=1.2
6+
git-changelog>=2.5
7+
twine>=5.0; python_version < '3.13'
88

99
# ci
10-
duty>=0.10
11-
ruff>=0.0
12-
pytest>=7.4
13-
pytest-cov>=4.1
10+
duty>=1.4
11+
ruff>=0.4
12+
pytest>=8.2
13+
pytest-cov>=5.0
1414
pytest-randomly>=3.15
15-
pytest-xdist>=3.3
16-
mypy>=1.5
17-
types-markdown>=3.5
15+
pytest-xdist>=3.6
16+
mypy>=1.10
17+
types-markdown>=3.6
1818
types-pyyaml>=6.0
19-
safety>=2.3
2019

2120
# docs
22-
black>=23.9
23-
markdown-callouts>=0.3
24-
markdown-exec>=1.7
25-
mkdocs>=1.5
21+
black>=24.4
22+
markdown-callouts>=0.4
23+
markdown-exec>=1.8
24+
mkdocs>=1.6
2625
mkdocs-coverage>=1.0
2726
mkdocs-gen-files>=0.5
28-
mkdocs-git-committers-plugin-2>=1.2
27+
mkdocs-git-committers-plugin-2>=2.3
2928
mkdocs-literate-nav>=0.6
30-
mkdocs-material>=9.4
31-
mkdocs-minify-plugin>=0.7
32-
mkdocstrings[python]>=0.23
33-
tomli>=2.0; python_version < '3.11'
29+
mkdocs-material>=9.5
30+
mkdocs-minify-plugin>=0.8
31+
mkdocstrings[python]>=0.25
32+
tomli>=2.0; python_version < '3.11'

‎docs/.overrides/main.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
{% block announce %}
44

5-
<a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>Sponsorship</strong></a>
6-
is now available!
5+
<strong>Fund this project</strong> through
6+
<a href="{{ 'insiders/#how-to-become-a-sponsor' | url }}"><strong>sponsorship</strong></a>
77
<span class="twemoji heart pulse">
88
{% include ".icons/octicons/heart-fill-16.svg" %}
99
</span> &mdash;
1010

11-
For updates follow <strong>@pawamoy</strong> on
11+
Follow
12+
<strong>@pawamoy</strong> on
1213
<a rel="me" href="https://fosstodon.org/@pawamoy">
1314
<span class="twemoji mastodon">
1415
{% include ".icons/fontawesome/brands/mastodon.svg" %}
1516
</span>
1617
<strong>Fosstodon</strong>
1718
</a>
19+
for updates
1820
{% endblock %}

‎docs/.overrides/partials/comments.html

+57
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<!-- Giscus -->
2+
<!-- https://squidfunk.github.io/mkdocs-material/setup/adding-a-comment-system/#giscus-integration -->
3+
<div id="feedback" style="display: none;">
4+
<h2 id="__comments">Feedback</h2>
5+
<script src="https://giscus.app/client.js"
6+
data-repo="mkdocstrings/typescript"
7+
data-repo-id="R_kgDOKutohQ"
8+
data-category="Documentation"
9+
data-category-id="DIC_kwDOKutohc4Chq2T"
10+
data-mapping="pathname"
11+
data-strict="1"
12+
data-reactions-enabled="0"
13+
data-emit-metadata="0"
14+
data-input-position="top"
15+
data-theme="preferred_color_scheme"
16+
data-lang="en"
17+
data-loading="lazy"
18+
crossorigin="anonymous"
19+
async>
20+
</script>
21+
22+
<!-- Synchronize Giscus theme with palette -->
23+
<script>
24+
var giscus = document.querySelector("script[src*=giscus]")
25+
26+
// Set palette on initial load
27+
var palette = __md_get("__palette")
28+
if (palette && typeof palette.color === "object") {
29+
var theme = palette.color.scheme === "slate"
30+
? "transparent_dark"
31+
: "light"
32+
33+
// Instruct Giscus to set theme
34+
giscus.setAttribute("data-theme", theme)
35+
}
36+
37+
// Register event handlers after documented loaded
38+
document.addEventListener("DOMContentLoaded", function() {
39+
var ref = document.querySelector("[data-md-component=palette]")
40+
ref.addEventListener("change", function() {
41+
var palette = __md_get("__palette")
42+
if (palette && typeof palette.color === "object") {
43+
var theme = palette.color.scheme === "slate"
44+
? "transparent_dark"
45+
: "light"
46+
47+
// Instruct Giscus to change theme
48+
var frame = document.querySelector(".giscus-frame")
49+
frame.contentWindow.postMessage(
50+
{ giscus: { setConfig: { theme } } },
51+
"https://giscus.app"
52+
)
53+
}
54+
})
55+
})
56+
</script>
57+
</div>

‎docs/index.md

+5
Original file line numberDiff line numberDiff line change
@@ -1 +1,6 @@
1+
---
2+
hide:
3+
- feedback
4+
---
5+
16
--8<-- "README.md"

‎docs/insiders/index.md

+4
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,10 @@ with your GitHub account, visit [pawamoy's sponsor profile][github sponsor profi
9898
and complete a sponsorship of **$10 a month or more**.
9999
You can use your individual or organization GitHub account for sponsoring.
100100

101+
Sponsorships lower than $10 a month are also very much appreciated, and useful.
102+
They won't grant you access to Insiders, but they will be counted towards reaching sponsorship goals.
103+
*Every* sponsorship helps us implementing new features and releasing them to the public.
104+
101105
**Important**: If you're sponsoring **[@pawamoy][github sponsor profile]**
102106
through a GitHub organization, please send a short email
103107
to insiders@pawamoy.fr with the name of your

0 commit comments

Comments
 (0)