Skip to content

Commit 9b4cd8c

Browse files
committed
chore: a few more updates inspired by copilot
Signed-off-by: Henry Schreiner <[email protected]>
1 parent 7e938b1 commit 9b4cd8c

File tree

2 files changed

+10
-9
lines changed

2 files changed

+10
-9
lines changed

docs/pages/guides/docs.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -271,7 +271,7 @@ While the cookie cutter creates a basic structure for your MkDocs (a top level
271271
`mkdocs.yml` file and the `docs` directory), you can also follow the official
272272
[Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/)
273273
guide instead. Note, however, instead of the `pip` install, it is better
274-
practise install your documentation dependencies via `pyproject.toml` and then
274+
practice install your documentation dependencies via `pyproject.toml` and then
275275
when you run your `uv sync` to install dependencies, you can explicitly ask for
276276
the `docs` group to be installed via `uv sync --group=docs` or
277277
`uv sync --all-groups`.
@@ -283,12 +283,12 @@ repository, you will already have this group. Otherwise, add to your
283283
```toml
284284
[dependency-groups]
285285
docs = [
286-
"Markdown>=3.9",
287-
"mkdocs>=1.1.2,<2",
288-
"mkdocs-material>=9.1.19,<10",
289-
"pyyaml>=6.0.1",
286+
"markdown>=3.9",
290287
"mdx-include>=1.4.2",
288+
"mkdocs-material>=9.1.19",
289+
"mkdocs>=1.1.2,",
291290
"mkdocstrings-python>=1.18.2",
291+
"pyyaml>=6.0.1",
292292
]
293293
```
294294

{{cookiecutter.project_name}}/pyproject.toml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,11 +135,12 @@ docs = [
135135
]
136136
{%- elif cookiecutter.docs == "mkdocs" %}
137137
docs = [
138-
"Markdown>=3.9",
139-
"mkdocs>=1.1.2,<2",
140-
"mkdocs-material>=9.1.19,<10",
141-
"pyyaml>=6.0.1",
138+
"markdown>=3.9",
139+
"mdx-include>=1.4.2",
140+
"mkdocs-material>=9.1.19",
141+
"mkdocs>=1.1.2",
142142
"mkdocstrings-python>=1.18.2",
143+
"pyyaml>=6.0.1",
143144
]
144145
{%- endif %}
145146

0 commit comments

Comments
 (0)