8000 chore: Template upgrade · mkdocstrings/python@6364fbc · GitHub
[go: up one dir, main page]
Skip to content

Commit 6364fbc

Browse files
pawamoypawamoy
committed
chore: Template upgrade
1 parent 548bdad commit 6364fbc

File tree

13 files changed

+79
-51
lines changed

13 files changed

+79
-51
lines changed

‎.copier-answers.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Changes here will be overwritten by Copier
2-
_commit: 1.2.0
2+
_commit: 1.2.6
33
_src_path: gh:pawamoy/copier-pdm
4-
author_email: pawamoy@pm.me
4+
author_email: dev@pawamoy.fr
55
author_fullname: Timothée Mazzucotelli
66
author_username: pawamoy
77
copyright_date: '2021'
88
copyright_holder: Timothée Mazzucotelli
9-
copyright_holder_email: pawamoy@pm.me
9+
copyright_holder_email: dev@pawamoy.fr
1010
copyright_license: ISC License
1111
insiders: true
12+
insiders_email: insiders@pawamoy.fr
1213
insiders_repository_name: mkdocstrings-python
1314
project_description: A Python handler for mkdocstrings.
1415
project_name: mkdocstrings-python

‎.github/workflows/ci.yml

Lines changed: 4 additions & 4 deletions

‎.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,13 @@ jobs:
2323

2424
steps:
2525
- name: Checkout
26-
uses: actions/checkout@v3
26+
uses: actions/checkout@v4
2727

2828
- name: Fetch all tags
2929
run: git fetch --depth=1 --tags
3030

3131
- name: Set up PDM
32-
uses: pdm-project/setup-pdm@v3
32+
uses: pdm-project/setup-pdm@v4
3333
with:
3434
python-version: "3.8"
3535

@@ -96,10 +96,10 @@ jobs:
9696

9797
steps:
9898
- name: Checkout
99-
uses: actions/checkout@v3
99+
uses: actions/checkout@v4
100100

101101
- name: Set up PDM
102-
uses: pdm-project/setup-pdm@v3
102+
uses: pdm-project/setup-pdm@v4
103103
with:
104104
python-version: ${{ matrix.python-version }}
105105
allow-python-prereleases: true
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
if: startsWith(github.ref, 'refs/tags/')
1111
steps:
1212
- name: Checkout
13-
uses: actions/checkout@v3
13+
uses: actions/checkout@v4
1414
- name: Fetch all tags
1515
run: git fetch --depth=1 --tags
1616
- name: Setup Python
@@ -22,7 +22,7 @@ jobs:
2222
if: github.repository_owner == 'pawamoy-insiders'
2323
run: python -m build
2424
- name: Upload dists artifact
25-
uses: actions/upload-artifact@v3
25+
uses: actions/upload-artifact@v4
2626
if: github.repository_owner == 'pawamoy-insiders'
2727
with:
2828
name: python-insiders

‎.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
.idea/
2+
.vscode/
23
__pycache__/
34
*.py[cod]
45
dist/

‎CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ representative at an online or offline event.
6060

6161
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6262
reported to the community leaders responsible for enforcement at
63-
pawamoy@pm.me.
63+
dev@pawamoy.fr.
6464
All complaints will be reviewed and investigated promptly and fairly.
6565

6666
All community leaders are obligated to respect the privacy and security of the

‎config/ruff.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
target-version = "py38"
2-
line-length = 132
2+
line-length = 120
33
exclude = [
44
"fixtures",
55
"site",
@@ -102,3 +102,7 @@ known-first-party = ["mkdocstrings_handlers"]
102102

103103
[pydocstyle]
104104
convention = "google"
105+
106+
[format]
107+
docstring-code-format = true
108+
docstring-code-line-length = 80

‎config/vscode/launch.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
"configurations": [
44
{
55
"name": "python (current file)",
6-
"type": "python",
6+
"type": "debugpy",
77
"request": "launch",
88
"program": "${file}",
99
"console": "integratedTerminal",
1010
"justMyCode": false
1111
},
1212
{
1313
"name": "test",
14-
"type": "python",
14+
"type": "debugpy",
1515
"request": "launch",
1616
"module": "pytest",
1717
"justMyCode": false,

‎docs/insiders/index.md

Lines changed: 29 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -65,17 +65,31 @@ data_source = [
6565
```
6666

6767
<!-- blacken-docs:off -->
68-
```python exec="1" session="insiders"
68+
```python exec="1" session="insiders" idprefix=""
6969
--8<-- "scripts/insiders.py"
7070

71-
print(
72-
f"""The moment you <a href="#how-to-become-a-sponsor">become a sponsor</a>, you'll get **immediate
73-
access to {len(unreleased_features)} additional features** that you can start using right away, and
74-
which are currently exclusively available to sponsors:\n"""
75-
)
76-
77-
for feature in unreleased_features:
78-
feature.render(badge=True)
71+
if unreleased_features:
72+
print(
73+
"The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get **immediate "
74+
f"access to {len(unreleased_features)} additional features** that you can start using right away, and "
75+
"which are currently exclusively available to sponsors:\n"
76+
)
77+
78+
for feature in unreleased_features:
79+
feature.render(badge=True)
80+
81+
print(
82+
"\n\nThese are just the features related to this project. "
83+
"[See the complete feature list on the author's main Insiders page](https://pawamoy.github.io/insiders/#whats-in-it-for-me)."
84+
)
85+
else:
86+
print(
87+
"The moment you [become a sponsor](#how-to-become-a-sponsor), you'll get immediate "
88+
"access to all released features that you can start using right away, and "
89+
"which are exclusively available to sponsors. At this moment, there are no "
90+
"Insiders features for this project, but checkout the [next funding goals](#goals) "
91+
"to see what's coming, as well as **[the feature list for all Insiders projects](https://pawamoy.github.io/insiders/#whats-in-it-for-me).**"
92+
)
7993
```
8094
<!-- blacken-docs:on -->
8195

@@ -88,7 +102,7 @@ You can use your individual or organization GitHub account for sponsoring.
88102

89103
**Important**: If you're sponsoring **[@pawamoy][github sponsor profile]**
90104
through a GitHub organization, please send a short email
91-
to pawamoy@pm.me with the name of your
105+
to insiders@pawamoy.fr with the name of your
92106
organization and the GitHub account of the individual
93107
that should be added as a collaborator.[^4]
94108

@@ -97,7 +111,7 @@ You can cancel your sponsorship anytime.[^5]
97111
[^4]:
98112
It's currently not possible to grant access to each member of an
99113
organization, as GitHub only allows for adding users. Thus, after
100-
sponsoring, please send an email to pawamoy@pm.me, stating which
114+
sponsoring, please send an email to insiders@pawamoy.fr, stating which
101115
account should become a collaborator of the Insiders repository. We're
102116
working on a solution which will make access to organizations much simpler.
103117
To ensure that access is not tied to a particular individual GitHub account,
@@ -120,10 +134,10 @@ You can cancel your sponsorship anytime.[^5]
120134

121135
<hr>
122136
<div class="premium-sponsors">
123-
124-
<div id="bronze-sponsors"></div>
137+
<div id="gold-sponsors"></div>
138+
<div id="silver-sponsors"></div>
139+
<div id="bronze-sponsors"></div>
125140
</div>
126-
127141
<hr>
128142

129143
<div id="sponsors"></div>
@@ -188,7 +202,7 @@ yearly billing cycle][billing cycle]. If for some reason you cannot do that, you
188202
could also create a dedicated GitHub account with a yearly billing cycle, which
189203
you only use for sponsoring (some sponsors already do that).
190204

191-
If you have any problems or further questions, please reach out to pawamoy@pm.me.
205+
If you have any problems or further questions, please reach out to insiders@pawamoy.fr.
192206

193207
### Terms
194208

‎docs/insiders/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ as it is against our [Terms of use](index.md#terms).**
143143
> ```bash
144144
> # clone the repository
145145
> git clone git@github.com:pawamoy-insiders/mkdocstrings-python
146-
> cd python
146+
> cd mkdocstrings-python
147147
>
148148
> # install build
149149
> pip install --user build
@@ -184,7 +184,7 @@ git clone git@github.com:pawamoy-insiders/mkdocstrings-python
184184
When cloning from `git`, the package must be installed:
185185

186186
```
187-
pip install -e python
187+
pip install -e mkdocstrings-python
188188
```
189189

190190
## Upgrading

‎docs/js/insiders.js

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,26 @@ function getJSON(url, callback) {
2121
xhr.send();
2222
}
2323

24+
function updatePremiumSponsors(dataURL, rank) {
25+
let capRank = rank.charAt(0).toUpperCase() + rank.slice(1);
26+
getJSON(dataURL + `/sponsors${capRank}.json`, function (err, sponsors) {
27+
const sponsorsDiv = document.getElementById(`${rank}-sponsors`);
28+
if (sponsors.length > 0) {
29+
let html = '';
30+
html += `<b>${capRank} sponsors</b><p>`
31+
sponsors.forEach(function (sponsor) {
32+
html += `
33+
<a href="${sponsor.url}" target="_blank" title="${sponsor.name}">
34+
<img alt="${sponsor.name}" src="${sponsor.image}" style="height: ${sponsor.imageHeight}px;">
35+
</a>
36+
`
37+
});
38+
html += '</p>'
39+
sponsorsDiv.innerHTML = html;
40+
}
41+
});
42+
}
43+
2444
function updateInsidersPage(author_username) {
2545
const sponsorURL = `https://github.com/sponsors/${author_username}`
2646
const dataURL = `https://raw.githubusercontent.com/${author_username}/sponsors/main`;
@@ -48,20 +68,7 @@ function updateInsidersPage(author_username) {
4868
}
4969
});
5070
});
51-
getJSON(dataURL + '/sponsorsBronze.json', function (err, sponsors) {
52-
const bronzeSponsors = document.getElementById("bronze-sponsors");
53-
if (sponsors) {
54-
let html = '';
55-
html += '<b>Bronze sponsors</b><p>'
56-
sponsors.forEach(function (sponsor) {
57-
html += `
58-
<a href="${sponsor.url}" target="_blank" title="${sponsor.name}">
59-
<img alt="${sponsor.name}" src="${sponsor.image}" style="height: ${sponsor.imageHeight}px;">
60-
</a>
61-
`
62-
});
63-
html += '</p>'
64-
bronzeSponsors.innerHTML = html;
65-
}
66-
});
71+
updatePremiumSponsors(dataURL, "gold");
72+
updatePremiumSponsors(dataURL, "silver");
73+
updatePremiumSponsors(dataURL, "bronze");
6774
}

‎duties.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
from typing import TYPE_CHECKING, Iterator
1111

1212
from duty import duty
13-
from duty.callables import black, coverage, lazy, mkdocs, mypy, pytest, ruff, safety
13+
from duty.callables import coverage, lazy, mkdocs, mypy, pytest, ruff, safety
1414

1515
if TYPE_CHECKING:
1616
from duty.context import Context
@@ -225,7 +225,7 @@ def format(ctx: Context) -> None:
225225
ruff.check(*PY_SRC_LIST, config="config/ruff.toml", fix_only=True, exit_zero=True),
226226
title="Auto-fixing code",
227227
)
228-
ctx.run(black.run(*PY_SRC_LIST, config="config/black.toml"), title="Formatting code")
228+
ctx.run(ruff.format(*PY_SRC_LIST, config="config/ruff.toml"), title="Formatting code")
229229

230230

231231
@duty(post=["docs-deploy"])

‎pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ build-backend = "pdm.backend"
55
[project]
66
name = "mkdocstrings-python"
77
description = "A Python handler for mkdocstrings."
8-
authors = [{name = "Timothée Mazzucotelli", email = "pawamoy@pm.me"}]
8+
authors = [{name = "Timothée Mazzucotelli", email = "dev@pawamoy.fr"}]
99
license = {text = "ISC"}
1010
readme = "README.md"
1111
requires-python = ">=3.8"

‎scripts/gen_ref_nav.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
nav = mkdocs_gen_files.Nav()
88
mod_symbol = '<code class="doc-symbol doc-symbol-nav doc-symbol-module"></code>'
99

10-
src = Path(__file__).parent.parent / "src"
10+
root = Path(__file__).parent.parent
11+
src = root / "src"
1112

1213
for path in sorted(src.rglob("*.py")):
1314
module_path = path.relative_to(src).with_suffix("")
@@ -30,7 +31,7 @@
3031
ident = ".".join(parts)
3132
fd.write(f"::: {ident}")
3233

33-
mkdocs_gen_files.set_edit_path(full_doc_path, ".." / path)
34+
mkdocs_gen_files.set_edit_path(full_doc_path, ".." / path.relative_to(root))
3435

3536
with mkdocs_gen_files.open("reference/SUMMARY.md", "w") as nav_file:
3637
nav_file.writelines(nav.build_literate_nav())

0 commit comments

Comments
 (0)
0