jj/mkdocs-offline.yml

# This config is good if you plan to use the rendered docs from
# your file system. To use, run:
#      poetry run -- mkdocs build -f mkdocs-offline.yml
INHERIT: 'mkdocs.yml'
plugins:
    - offline
# 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
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 04:11:30 +00:00			`# This config is good if you plan to use the rendered docs from`
			`# your file system. To use, run:`
mkdocs-offline.yml: fix a typo, forgot a word 2023-10-03 07:05:05 +00:00			`# poetry run -- mkdocs build -f mkdocs-offline.yml`
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 04:11:30 +00:00			`INHERIT: 'mkdocs.yml'`
			`plugins:`
			`- offline`
			# 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`