pFad - Phone/Frame/Anonymizer/Declutterfier! Saves Data!


--- a PPN by Garber Painting Akron. With Image Size Reduction included!

URL: http://github.com/leodevian/modern-python/commit/56d948ecee09567b4e7998949d656bf2c6008901

/> docs: use Zensical · leodevian/modern-python@56d948e · GitHub
Skip to content

Commit 56d948e

Browse files
leodevianleodevian
committed
docs: use Zensical
1 parent f716745 commit 56d948e

File tree

8 files changed

+163
-438
lines changed

8 files changed

+163
-438
lines changed

‎docs/changelog.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
---
2+
icon: lucide/rocket
3+
---
4+
15
--8<-- "CHANGELOG.md"

‎docs/index.md‎

Lines changed: 41 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
---
2-
hide:
3-
- toc
2+
icon: lucide/house
43
---
54

65
# modern-python
@@ -16,32 +15,55 @@ hide:
1615

1716
[Copier](https://copier.readthedocs.io/) template for modern Python packages.
1817

19-
This Copier template requires:
18+
!!! note "Prerequisites"
2019

21-
- [Git](https://git-scm.com/) version 2.
22-
- [Python](https://www.python.org/) 3.9 or more.
23-
- [Copier](https://copier.readthedocs.io/) version 9.6 or more.
24-
- [Copier Template-Extensions](https://github.com/copier-org/copier-template-extensions) version 0.3.2 or more.
20+
This Copier template requires:
2521

26-
To install Git, [download and install it from the official website](https://git-scm.com/downloads).
22+
- [Git](https://git-scm.com/) version 2.
23+
- [Python](https://www.python.org/) 3.9 or more.
24+
- [Copier](https://copier.readthedocs.io/) version 9.6 or more.
25+
- [Copier Template-Extensions](https://github.com/copier-org/copier-template-extensions) version 0.3.2 or more.
2726

28-
To install Python, [download and install it from the official website](https://www.python.org/downloads/),
29-
or [install uv](https://docs.astral.sh/uv/getting-started/installation/) to install it.
27+
To install Git, [download and install it from git-scm.com](https://git-scm.com/downloads).
3028

31-
To install Copier and Copier Template-Extensions, use [uv](https://docs.astral.sh/uv/):
29+
To install Python, [download and install it from python.org](https://www.python.org/downloads/),
30+
or [install uv](https://docs.astral.sh/uv/getting-started/installation/) to install it.
3231

33-
<!-- termynal -->
32+
To install Copier and Copier Template-Extensions, use [uv](https://docs.astral.sh/uv/)
33+
or [pipx](https://pipx.pypa.io/):
3434

35-
```
36-
$ uv tool install copier --with copier-template-extensions
37-
---> 100%
38-
Installed 1 executable: copier
39-
```
35+
=== "uv"
36+
37+
```
38+
39+
uv tool install copier --with copier-template-extensions
40+
```
41+
42+
=== "pipx"
43+
44+
```
45+
pipx install copier
46+
pipx inject copier copier-template-extensions
47+
```
48+
49+
## Usage
4050

4151
Run `copier copy` to generate your Python package:
4252

43-
<!-- termynal -->
53+
=== "HTTPS"
54+
55+
```
56+
copier copy --trust gh:leodevian/modern-python ./path/to/directory
57+
```
58+
59+
=== "SSH"
60+
61+
```
62+
copier copy --trust git@github.com:leodevian/modern-python ./path/to/directory
63+
```
64+
65+
Run `copier update` to update your Python package to the latest version:
4466

4567
```
46-
$ copier copy --trust gh:leodevian/modern-python ./path/to/directory
68+
copier update --trust
4769
```

‎docs/license.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: lucide/scale
3+
---
4+
15
```text
26
--8<-- "LICENSE"
37
```

‎mkdocs.yml‎

Lines changed: 0 additions & 69 deletions
This file was deleted.

‎pyproject.toml‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ type = [
5858
{ include-group = "test" },
5959
]
6060
docs = [
61-
"mkdocs>=1.6.1",
62-
"mkdocs-material>=9.7",
63-
"termynal>=0.13.1",
61+
"zensical>=0.0.11",
6462
]
6563
lint = [
6664
"pre-commit>=4.5",

‎tox.toml‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,9 @@ skip_install = true
4444
dependency_groups = [ "docs" ]
4545
commands = [
4646
[
47-
"mkdocs",
47+
"zensical",
4848
"build",
4949
"--clean",
50-
"--strict",
51-
"--site-dir",
52-
"{env_tmp_dir}",
5350
{ replace = "posargs", extend = true },
5451
],
5552
]
@@ -60,9 +57,8 @@ skip_install = true
6057
dependency_groups = [ "docs" ]
6158
commands = [
6259
[
63-
"mkdocs",
60+
"zensical",
6461
"serve",
65-
"--strict",
6662
"--open",
6763
{ replace = "posargs", extend = true },
6864
],

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad © 2024 Your Company Name. All rights reserved.




Check this box to remove all script contents from the fetched content.



Check this box to remove all images from the fetched content.


Check this box to remove all CSS styles from the fetched content.


Check this box to keep images inefficiently compressed and original size.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy