ilyagr.bsky.social
just playing with tangled
1# The `dev` dependency group sets up tools for building `jj`
2# documentation. `uv` will install these in a virtual environment.
3
4[project]
5name = "jj-docs"
6description = "Sets up MkDocs and related Python tools"
7requires-python = ">=3.9"
8version = "0.1.0"
9dependencies = []
10
11[dependency-groups]
12# These can be updated with `uv add --dev`.
13dev = [
14 "mkdocs<1.7,>=1.6",
15 # Pin mkdocs-material to the exact version b/c it sometimes breaks thing
16 "mkdocs-material==9.6.4",
17 # Versioning of documentation
18 "mike<3,>=2.1.3",
19 # (Py)Markdown extensions
20 "mdx-truly-sane-lists<2.0,>=1.3",
21 "mdx-breakless-lists<2.0.0,>=1.0.1",
22 # Allows setting up redirects when renaming docs files
23 "mkdocs-redirects<2.0.0,>=1.2.1",
24 # Used for the CLI reference
25 "mkdocs-include-markdown-plugin<8.0.0,>=7.1.4",
26 # Unrelated to docs
27 "codespell[toml]>=2.4.0",
28]
29
30[tool.uv]
31package = false
32
33[tool.codespell]
34check-filenames = true
35check-hidden = true
36# Codespell does not respect .gitignore. It may be necessary to add to
37# this list by running e.g. `uv run codespell --skip=./rendered-docs`
38# if you have less common ignored files or globally ignored files present.
39# Alternatively, try `uv run codespell $(jj file list)`.
40skip = "./target,./.jj,*.lock,./.git,./.venv,./.direnv"
41ignore-words-list = "crate,NotIn,Wirth,abd,ratatui"