Skip to content

Commit 143b3e7

Browse files
committed
chore: Template upgrade
1 parent a154c05 commit 143b3e7

8 files changed

Lines changed: 13 additions & 42 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: 0.7.3
2+
_commit: 0.8.1
33
_src_path: gh:pawamoy/copier-pdm
44
author_email: pawamoy@pm.me
55
author_fullname: "Timoth\xE9e Mazzucotelli"

.github/workflows/ci.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ jobs:
7373
- macos-latest
7474
- windows-latest
7575
python-version:
76+
- "3.7"
7677
- "3.8"
7778
- "3.9"
7879
- "3.10"

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ A legacy Python handler for mkdocstrings.
1010

1111
## Requirements
1212

13-
mkdocstrings-python (legacy) requires Python 3.6 or above.
13+
mkdocstrings-python (legacy) requires Python 3.7 or above.
1414

1515
<details>
16-
<summary>To install Python 3.6, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
16+
<summary>To install Python 3.7, I recommend using <a href="https://github.com/pyenv/pyenv"><code>pyenv</code></a>.</summary>
1717

1818
```bash
1919
# install pyenv
@@ -24,24 +24,23 @@ export PATH="${HOME}/.pyenv/bin:${PATH}"
2424
export PYENV_ROOT="${HOME}/.pyenv"
2525
eval "$(pyenv init -)"
2626

27-
# install Python 3.6
28-
pyenv install 3.6.12
27+
# install Python 3.7
28+
pyenv install 3.7.12
2929

3030
# make it available globally
31-
pyenv global system 3.6.12
31+
pyenv global system 3.7.12
3232
```
3333
</details>
3434

3535
## Installation
3636

3737
With `pip`:
3838
```bash
39-
python3.6 -m pip install mkdocstrings-python-legacy
39+
pip install mkdocstrings-python-legacy
4040
```
4141

4242
With [`pipx`](https://github.com/pipxproject/pipx):
4343
```bash
44-
python3.6 -m pip install --user pipx
45-
46-
pipx install --python python3.6 mkdocstrings-python-legacy
44+
python3.7 -m pip install --user pipx
45+
pipx install mkdocstrings-python-legacy
4746
```

docs/gen_ref_nav.py

100644100755
File mode changed.

duties.py

Lines changed: 0 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
import sys
77
import tempfile
88
from contextlib import suppress
9-
from functools import wraps
109
from io import StringIO
1110
from pathlib import Path
1211
from typing import List, Optional, Pattern
@@ -168,32 +167,7 @@ def safety(): # noqa: WPS430
168167
ctx.run(safety, title="Checking dependencies")
169168

170169

171-
def no_docs_py36(nofail=True):
172-
"""
173-
Decorate a duty that builds docs to warn that it's not possible on Python 3.6.
174-
175-
Arguments:
176-
nofail: Whether to fail or not.
177-
178-
Returns:
179-
The decorated function.
180-
"""
181-
182-
def decorator(func):
183-
@wraps(func)
184-
def wrapper(ctx):
185-
if sys.version_info <= (3, 7, 0):
186-
ctx.run(["false"], title="Docs can't be built on Python 3.6", nofail=nofail, quiet=True)
187-
else:
188-
func(ctx)
189-
190-
return wrapper
191-
192-
return decorator
193-
194-
195170
@duty
196-
@no_docs_py36()
197171
def check_docs(ctx):
198172
"""
199173
Check if the documentation builds correctly.
@@ -281,7 +255,6 @@ def clean(ctx):
281255

282256

283257
@duty
284-
@no_docs_py36(nofail=False)
285258
def docs(ctx):
286259
"""
287260
Build the documentation locally.
@@ -293,7 +266,6 @@ def docs(ctx):
293266

294267

295268
@duty
296-
@no_docs_py36(nofail=False)
297269
def docs_serve(ctx, host="127.0.0.1", port=8000):
298270
"""
299271
Serve the documentation (localhost:8000).
@@ -307,7 +279,6 @@ def docs_serve(ctx, host="127.0.0.1", port=8000):
307279

308280

309281
@duty
310-
@no_docs_py36(nofail=False)
311282
def docs_deploy(ctx):
312283
"""
313284
Deploy the documentation on GitHub pages.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ docs = [
5656
"mkdocs-gen-files>=0.3",
5757
"mkdocs-literate-nav>=0.4",
5858
"mkdocs-material>=7.3",
59-
"mkdocs-section-index",
59+
"mkdocs-section-index>=0.3",
6060
"toml>=0.10",
6161
]
6262
format = [

scripts/multirun.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
set -e
33

4-
PYTHON_VERSIONS="${PYTHON_VERSIONS-3.8 3.9 3.10 3.11}"
4+
PYTHON_VERSIONS="${PYTHON_VERSIONS-3.7 3.8 3.9 3.10 3.11}"
55

66
if [ -n "${PYTHON_VERSIONS}" ]; then
77
for python_version in ${PYTHON_VERSIONS}; do

scripts/setup.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#!/usr/bin/env bash
22
set -e
33

4-
PYTHON_VERSIONS="${PYTHON_VERSIONS-3.8 3.9 3.10 3.11}"
4+
PYTHON_VERSIONS="${PYTHON_VERSIONS-3.7 3.8 3.9 3.10 3.11}"
55

66
install_with_pipx() {
77
if ! command -v "$1" &>/dev/null; then

0 commit comments

Comments
 (0)