jj/pyproject.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",
]
docs: Set up `mkdocs` and `poetry` I initially was thinking of using `mdbook`, which looks a little better, but I think versioning the docs is important, and the features I want are pretty much only supported by the Mkdocs' "Material" theme. Mkdocs is written in Python. The prerequesites for building docs on your machine should be to install Python and Poetry, everything else should be installed automatically by Poetry. See the edits to `contributing.md` for more details. 2023-08-18 23:43:20 +00:00			# The `dev-dependencies` section sets up tools for building `jj`
docs: migrate from poetry to uv Our docs are built with MkDocs, which requires Python and several deps. Previously those deps were managed with Poetry, which is also written in Python. This commit replaces Poetry with `uv`, a Rust-based Python project/package manager, and thus removes several steps from the docs build process. Before: <install Python> <install pipx> pipx install poetry poetry install poetry run -- mkdocs serve After: <install uv> uv run mkdocs serve 2024-11-09 21:32:29 +00:00			# documentation. `uv` will install these in a virtual environment.
docs: Set up `mkdocs` and `poetry` I initially was thinking of using `mdbook`, which looks a little better, but I think versioning the docs is important, and the features I want are pretty much only supported by the Mkdocs' "Material" theme. Mkdocs is written in Python. The prerequesites for building docs on your machine should be to install Python and Poetry, everything else should be installed automatically by Poetry. See the edits to `contributing.md` for more details. 2023-08-18 23:43:20 +00:00
docs: migrate from poetry to uv Our docs are built with MkDocs, which requires Python and several deps. Previously those deps were managed with Poetry, which is also written in Python. This commit replaces Poetry with `uv`, a Rust-based Python project/package manager, and thus removes several steps from the docs build process. Before: <install Python> <install pipx> pipx install poetry poetry install poetry run -- mkdocs serve After: <install uv> uv run mkdocs serve 2024-11-09 21:32:29 +00:00			`[project]`
			`name = "jj-docs"`
			`description = "Sets up MkDocs and related Python tools"`
			`requires-python = ">=3.9"`
			`version = "0.1.0"`
			`dependencies = []`
docs: Set up `mkdocs` and `poetry` I initially was thinking of using `mdbook`, which looks a little better, but I think versioning the docs is important, and the features I want are pretty much only supported by the Mkdocs' "Material" theme. Mkdocs is written in Python. The prerequesites for building docs on your machine should be to install Python and Poetry, everything else should be installed automatically by Poetry. See the edits to `contributing.md` for more details. 2023-08-18 23:43:20 +00:00
docs: migrate from poetry to uv Our docs are built with MkDocs, which requires Python and several deps. Previously those deps were managed with Poetry, which is also written in Python. This commit replaces Poetry with `uv`, a Rust-based Python project/package manager, and thus removes several steps from the docs build process. Before: <install Python> <install pipx> pipx install poetry poetry install poetry run -- mkdocs serve After: <install uv> uv run mkdocs serve 2024-11-09 21:32:29 +00:00			`[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",`
			`]`