ok/jj
1
0
Fork 0
forked from mirrors/jj
Code Pull requests Activity
jj/pyproject.toml

28 lines
719 B
TOML
Raw Normal View History

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"
poetry: Update pyproject.toml to use newer convention The previous commit checks that Poetry down to version 1.3.2 (current Debian stable version) support it.
2023-11-03 05:47:47 +00:00
[tool.poetry.group.dev.dependencies]
poetry: update mkdocs-material in pyproject.toml Considering the previous commit, it's unclear how compatible we are with previous mkdocs-material versions.
2023-11-02 05:45:46 +00:00
# These can be updated with `poetry add`.
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 = "^1.5.2"
docs: update mkdocs-material to 9.5 This will allow for better toggles in https://github.com/martinvonz/jj/pull/2783
2024-01-06 19:40:33 +00:00
mkdocs-material = "^9.5"
mkdocs: make MkDocs work with more GitHub-like list formatting This adds two MkDocs extensions to make list handling more flexible. It took some trial-and-error, but it seems this config works OK. revsets.md: use saner formatting that is now possible. sapling-comparison.md: this was the one case I saw made worse by the new plugins. I changed the Markdown formatting, it still looks sane.
2023-11-02 05:26:07 +00:00
# (Py)Markdown extensions
mdx-truly-sane-lists = "^1.3"
mdx-breakless-lists = "^1.0.1"
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
website: upgrade `mike` to version 2.0 https://github.com/jimporter/mike/releases/tag/v2.0.0 The main immediate advantage of this is that `mike` will stop pushing empty commits. Also, we can consider switching to using symlinks instead of redirects for mapping the "latest" version to "v0.11.0". This would make `https://martinvonz.github.io/jj/latest/` have the same content as `https://martinvonz.github.io/jj/v0.11.0/` (until the next version is out), but the user would see `latest` in the URL. For now, I set an option to keep using redirects. I did a bit of non-exhaustive testing; it seems to work.
2023-11-03 05:47:47 +00:00
mike = "^2.0.0"
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
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
Copy permalink