mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2024-11-28 00:56:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
7495 commits 92 branches 28 tags 47 MiB
Commit graph

5 commits

Author SHA1 Message Date
Emily
cedaa5bb00 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-20 06:06:53 +01:00
Ilya Grigoriev
1c397b5d1b docs website & mkdocs.yml: redirect /branches/ URL 
After this is merged, https://martinvonz.github.io/jj/prerelease/branches/
should redirect to https://martinvonz.github.io/jj/prerelease/bookmarks/
instead of resulting in a 404 error and old links to docs
(from posts or from Google index) breaking.
 2024-09-16 16:44:31 -07:00
Ilya Grigoriev
44e1d4a72d docs: fix a bug with offline docs generation 
This is a rather annoying bug. It was revealed because CLI reference stopped
working for *offline* docs after the previous commit. Turns out, none of the
plugins we enabled for normal docs were turned on in `mkdocs-offline.yml`.

Thanks to @mondeja for figuring out what was going on.

In the future, we could try a less ugly fix, e.g. turning the `offline` plugin
on or off via an environment variable.

See also:
https://github.com/squidfunk/mkdocs-material/issues/6749
https://github.com/mondeja/mkdocs-include-markdown-plugin/issues/195#issuecomment-1933085478
 2024-02-12 10:28:09 -08:00
Ilya Grigoriev
b1b8f85005 mkdocs-offline.yml: fix a typo, forgot a word 2023-10-03 06:52:44 -07:00
Ilya Grigoriev
dbbed2d2a5 docs: restore directory structure of the website 
The `offline` plugin added to the MkDocs config in commit 772e2b8 ended up
changing the directory structure of the website, see the resulting commit
56aec196.

**Before** that commit, the following URLs were valid:

<https://martinvonz.github.io/jj/v0.9.0/revsets>
<https://martinvonz.github.io/jj/v0.9.0/revsets/>

and <https://martinvonz.github.io/jj/v0.9.0/revsets.html> was invalid.

The situation described above should be restored by this commit.

**After** 772e2b8 and before this commit, the following URLs were valid:

<https://martinvonz.github.io/jj/v0.9.0/revsets>
<https://martinvonz.github.io/jj/v0.9.0/revsets.html> and
<https://martinvonz.github.io/jj/v0.9.0/revsets/> was invalid.

This commit is likely to break the version switcher between v0.9.0 and newer
versions. The breakage would be minimized if this is merged shortly before a
release (but with enough time to test it out). Alternatively, I could try to
fix up the docs for that version.

We could also consciously decide to leave things as they are now.

The problem was noticed by @hooper, who noticed URLs in their browser history
that were no longer valid.
 2023-10-02 20:40:23 -07:00