mirror of
https://github.com/martinvonz/jj.git
synced 2025-02-07 13:00:08 +00:00
c5e30f9f30
The primary goal is to control the version of the `codespell` Python package that we run via `uv.lock`. See also https://github.com/jj-vcs/jj/pull/5425. Also move the action next to the `cargo fmt` action. It might make sense to split both of them out of `build.yml` if it gets too long, but I think they should be next to each other since they are so similar in spirit.
39 lines
1.3 KiB
TOML
39 lines
1.3 KiB
TOML
# The `dev-dependencies` section sets up tools for building `jj`
|
|
# documentation. `uv` will install these in a virtual environment.
|
|
|
|
[project]
|
|
name = "jj-docs"
|
|
description = "Sets up MkDocs and related Python tools"
|
|
requires-python = ">=3.9"
|
|
version = "0.1.0"
|
|
dependencies = []
|
|
|
|
[tool.uv]
|
|
package = false
|
|
# These can be updated with `uv add --dev`.
|
|
dev-dependencies = [
|
|
"mkdocs<1.7,>=1.6",
|
|
# Pin mkdocs-material to the exact version b/c it sometimes breaks thing
|
|
"mkdocs-material==9.5.39",
|
|
# Versioning of documentation
|
|
"mike<3,>=2.1.3",
|
|
# (Py)Markdown extensions
|
|
"mdx-truly-sane-lists<2.0,>=1.3",
|
|
"mdx-breakless-lists<2.0.0,>=1.0.1",
|
|
# Allows setting up redirects when renaming docs files
|
|
"mkdocs-redirects<2.0.0,>=1.2.1",
|
|
# Used for the CLI reference
|
|
"mkdocs-include-markdown-plugin<7.0.0,>=6.0.4",
|
|
"codespell[toml]>=2.4.0",
|
|
]
|
|
|
|
[tool.codespell]
|
|
check-filenames=true
|
|
check-hidden=true
|
|
# Codespell does not respect .gitignore. It may be necessary to add to
|
|
# this list by running e.g. `uv run codespell --skip=./rendered-docs`
|
|
# if you have less common ignored files or globally ignored files present.
|
|
# Alternatively, try `uv run codespell $(jj file list)`.
|
|
skip="./target,./.jj,*.lock,./.git,./.venv,./.direnv"
|
|
ignore-words-list="crate,NotIn,Wirth,abd"
|
|
|