mirror of
https://github.com/martinvonz/jj.git
synced 2024-09-20 10:18:23 +03:00
fc49258d2f
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.
24 lines
601 B
TOML
24 lines
601 B
TOML
# The `dev-dependencies` section sets up tools for building `jj`
|
|
# documentation. `poetry` will install these in a virtual environment.
|
|
# The other sections are unused.
|
|
[tool.poetry]
|
|
name = "jj-docs"
|
|
version = "0"
|
|
description = ""
|
|
authors = []
|
|
|
|
[tool.poetry.dependencies]
|
|
python = "^3.8"
|
|
|
|
[tool.poetry.dev-dependencies]
|
|
mkdocs = "^1.5.2"
|
|
mkdocs-material = "^9.2.5"
|
|
# Makes `install-and-setup.md` open by default instead of `index.md`.
|
|
mkdocs-redirects = "^1.2.1"
|
|
# Versioning of documentation
|
|
mike = "^1.1.2"
|
|
|
|
[build-system]
|
|
requires = ["poetry-core>=1.0.0"]
|
|
build-backend = "poetry.core.masonry.api"
|