Skip to content

Commit 1d2b72c

Browse files
Configure mkdocs
1 parent 3dcd4c7 commit 1d2b72c

9 files changed

Lines changed: 316 additions & 1 deletion

File tree

File renamed without changes.

docs/index.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# usethis
2+
3+
Automate Python project setup and development tasks that are otherwise performed manually.
4+
5+
usethis knows about popular Python tools, workflows and frameworks, and knows how they
6+
interact. It can add and remove tools, configure them, and set up the project for you
7+
in a way that won't break your existing configuration and it will make the necessary
8+
adjustments to your project configuration files.
9+
10+
usethis gives detailed messages about what it is doing (and what you need to do next).
11+
12+
- Output beginning with `` represents a task which usethis has automated.
13+
- Output beginning with `` represents a task which you need to perform manually.
14+
- Output beginning with `` gives hints and tips.
15+
16+
Inspired by an [**R** package of the same name](https://usethis.r-lib.org/index.html),
17+
this package brings a similar experience to the Python ecosystem as a CLI tool.
18+
19+
See the [README.md file](https://github.com/nathanjmcdougall/usethis-python/blob/main/README.md) for more information.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

mkdocs.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
site_name: usethis
2+
3+
nav:
4+
- Home: index.md
5+
6+
theme:
7+
name: material
8+
logo: logo.svg
9+
palette:
10+
- media: "(prefers-color-scheme)"
11+
toggle:
12+
icon: material/brightness-6
13+
name: Switch between light and dark mode
14+
- media: "(prefers-color-scheme: dark)"
15+
primary: black
16+
scheme: slate
17+
toggle:
18+
icon: material/brightness-6
19+
name: Switch to light mode
20+
- media: "(prefers-color-scheme: light)"
21+
primary: black
22+
scheme: default
23+
toggle:
24+
icon: material/brightness-6
25+
name: Switch to dark mode
26+
27+
plugins:
28+
- search
29+

pyproject.toml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,10 @@ test = [
6464
"pytest-emoji>=0.2.0",
6565
"pytest-md>=0.2.0",
6666
]
67+
doc = [
68+
"mkdocs>=1.6.1",
69+
"mkdocs-material>=9.6.3",
70+
]
6771

6872
[tool.hatch.version]
6973
source = "vcs"
@@ -134,7 +138,7 @@ exclude_also = [
134138
]
135139

136140
[tool.uv]
137-
default-groups = [ "test", "dev" ]
141+
default-groups = [ "test", "dev", "doc" ]
138142

139143
[tool.importlinter]
140144
root_packages = [ "usethis" ]

uv.lock

Lines changed: 263 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)