mirror of
https://github.com/martinvonz/jj.git
synced 2025-02-06 11:34:54 +00:00
cedaa5bb00
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
19 lines
724 B
YAML
19 lines
724 B
YAML
# This config is good if you plan to use the rendered docs from
|
|
# your file system. To use, run:
|
|
# uv run mkdocs build -f mkdocs-offline.yml
|
|
INHERIT: 'mkdocs.yml'
|
|
plugins:
|
|
- offline
|
|
|
|
# For now, *every plugin config* from `mkdocs.yml` has to be repeated here.
|
|
# https://github.com/mondeja/mkdocs-include-markdown-plugin/issues/195#issuecomment-1933085478
|
|
# https://github.com/mkdocs/mkdocs/issues/3216
|
|
- include-markdown # For the CLI reference
|
|
- search
|
|
- redirects:
|
|
redirect_maps:
|
|
branches.md: bookmarks.md
|
|
# Turns out the `offline` plugin forces the following
|
|
# option no matter what, and therefore shouldn't be
|
|
# used in the main config file.
|
|
use_directory_urls: false
|