Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: try upgrading mkdocs-material again #3676

Merged
merged 1 commit into from
May 13, 2024

Conversation

ilyagr
Copy link
Collaborator

@ilyagr ilyagr commented May 12, 2024

squidfunk/mkdocs-material#7160 is supposed to
be fixed now. I will double-check that the version switcher still works
after this commit. This only affects the version switcher from
"prerelease" to other versions, until there's another jj release.
The functionality is a bit brittle, so
it's hard to test locally before merging this.

We do want to upgrade, since this allows us (and seems to also require
us) to upgrade to MkDocs 1.6, which has a nice feature of disallowing
links to broken document section (beyond just checking for links to
non-existent files).

I carefully avoided unnecessary upgrades in this commit, but we
should also run poetry update shortly, once we check this
works properly. Also, the feature of MkDocs 1.6 I mentioned needs
enabling.

Finally, I plan to change version specifiers from Poetry's ^5.6.22
syntax to more plain inequalities, since I keep forgetting what the
former syntax means. I started with this commit.

(I was surprised MkDocs was allowed to be upgraded to 1.6 with the ^1.5.2 spec.
I now suspect that what I previously thought it should mean is expressed
as ~1.5.2, but inequalities are clearer).

@ilyagr ilyagr force-pushed the upgradematerial branch 2 times, most recently from 0d7169a to 3b1bee8 Compare May 12, 2024 21:14
@ilyagr ilyagr marked this pull request as ready for review May 12, 2024 21:16
@ilyagr ilyagr force-pushed the upgradematerial branch 2 times, most recently from 253a8ba to 82f74ea Compare May 12, 2024 21:37
squidfunk/mkdocs-material#7160 is supposed to
be fixed now. I will double-check that the version switcher still works
after this commit. This only affects the version switcher from
"prerelease" to other versions.. The functionality is a bit brittle, so
it's hard to test locally before merging this.

We do want to upgrade, since this allows us (and seems to also require
us) to upgrade to MkDocs 1.6, which has a nice feature of disallowing
links to broken document section (beyond just checking for links to
non-existent files).

I carefully avoided unnecessary upgrades in this commit, but we
should also run `poetry update` shortly, once we check this
works properly. Also, the feature of MkDocs 1.6 I mentioned needs
enabling.

Finally, I plan to change version specifiers from Poetry's `^5.6.22`
syntax to more plain inequalities, since I keep forgetting what the
former syntax means. I started with this commit.

(I was surprised MkDocs was allowed to be upgraded to `1.6` with the
`^1.5.2` spec.  I now suspect that what I previously thought it should
mean is expressed as `~1.5.2`, but inequalities are clearer).
@ilyagr ilyagr merged commit 02b72e5 into martinvonz:main May 13, 2024
16 checks passed
@ilyagr ilyagr deleted the upgradematerial branch May 13, 2024 16:14
@ilyagr ilyagr restored the upgradematerial branch May 13, 2024 16:15
@ilyagr
Copy link
Collaborator Author

ilyagr commented May 13, 2024

The version switcher seems to work fine. 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants