1
# The `dev` dependency group sets up tools for building `jj`
2
# documentation. `uv` will install these in a virtual environment.
3
4
[project]
5
name = "jj-docs"
6
description = "Sets up MkDocs and related Python tools"
7
requires-python = ">=3.9"
8
version = "0.1.0"
9
dependencies = []
10
11
[dependency-groups]
12
# These can be updated with `uv add --dev`.
13
dev = [
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.23",
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
# Used to render Markdown tables from YAML files
27
"mkdocs-table-reader-plugin>=3.1.0",
28
# Unrelated to docs
29
"codespell[toml]>=2.4.0",
30
]
31
32
[tool.uv]
33
package = false
34
# Pygments 2.20.0 caused https://github.com/jj-vcs/jj/issues/9230
35
# For example, the `github` docs ended up having literal "```shell" in them,
36
# see the exact breakage in
37
# https://github.com/jj-vcs/jj/commit/8a13bde3bb9555ba1d25ace3d3ecff71ef5e0f76#diff-b50ce796f4ee4de132496e90aa1f463d50f2454bbd41796013e52b06ed1da691R1943-R1947
38
# TODO: Consider fixing this if our planned transition to starlight docs doesn't work out for some reason.
39
constraint-dependencies = ["pygments<2.20"]
40
41
[tool.codespell]
42
# codespell must be run **from the repo root** for these settings
43
# to take effect.
44
check-filenames = true
45
check-hidden = true
46
# Codespell does not respect .gitignore. It may be necessary to add to
47
# this list by running e.g. `uv run codespell --skip=./rendered-docs`
48
# if you have less common ignored files or globally ignored files present.
49
# Alternatively, try `uv run codespell $(jj file list)`.
50
skip = "./target,./.jj,*.lock,./.git,./.venv,./.direnv,**/*.svg,package-lock.json,node_modules,.astro"
51
ignore-words-list = "crate,ser,NotIn,Wirth,abd,ratatui,grey"
52
dictionary = ".config/codespell-additional-dict,-"
53
builtin = "clear,rare,en-GB_to_en-US"
54
