jj/pyproject.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"
# Allows setting up redirects when renaming docs files
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"
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`
			# 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"`
docs: create a basic homepage for the docs website Before, https://martinvonz.github.io/jj/latest redirected to https://martinvonz.github.io/jj/latest/install-and-setup.html. Now, it will direct people to a basic page with a link to the repo and a few other useful pages. An additional motivation is the desire to have a homepage to link to from https://github.com/martinvonz/jj/pull/2273#discussion_r1331008117. Better something very basic than nothing. 2023-10-04 01:20:04 +00:00			`# Allows setting up redirects when renaming docs files`
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			`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"`