Skip to content

Update click, mark mkdocs as not to be upgraded.#204

Merged
freakboy3742 merged 2 commits intobeeware:mainfrom
kattni:tooling/click-update
Apr 6, 2026
Merged

Update click, mark mkdocs as not to be upgraded.#204
freakboy3742 merged 2 commits intobeeware:mainfrom
kattni:tooling/click-update

Conversation

@kattni
Copy link
Copy Markdown
Collaborator

@kattni kattni commented Apr 5, 2026

Click has finally posted an update that fixes the issue that was causing MkDocs live serve to fail.

literate-nav now has a warning stating that it's possible that MkDocs 2.0 may, without warning, replace the pip install mkdocs install. It seems unlikely to be a direct replacement for the current version. I have preemptively added a warning about now upgrading MkDocs, should this happen.

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

@kattni
Copy link
Copy Markdown
Collaborator Author

kattni commented Apr 5, 2026

This failure is happening on main as well. Looking into it.

@kattni
Copy link
Copy Markdown
Collaborator Author

kattni commented Apr 5, 2026

There are two spots in every translation where the {% endif %} was missing. In sorting that out, I noticed that some of the tabbed content labels were translated; they are the same ones in every file, and it's not all of them. I have no idea why it's happening this way. I pushed the manual updates to the PO files so the locations of the issues were easy to communicate.

Copy link
Copy Markdown
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As discussed in person yesterday, there's some rendering issues that seem to be related to translation of code blocks - but those were pre-existing. Landing this as is because it's clearly a fix for other problems (see beeware/beeware.github.io#766).

@freakboy3742 freakboy3742 merged commit ffc1989 into beeware:main Apr 6, 2026
4 checks passed
@freakboy3742 freakboy3742 deleted the tooling/click-update branch April 6, 2026 22:32
@johnzhou721
Copy link
Copy Markdown
Contributor

literate-nav now has a warning stating that it's possible that MkDocs 2.0 may, without warning, replace the pip install mkdocs install. It seems unlikely to be a direct replacement for the current version. I have preemptively added a warning about now upgrading MkDocs, should this happen.

For posterity: The relevant reference is mkdocs/mkdocs#4077 — and the thread seems like the single maintainer is looking to entirely replace and massively simplify MkDocs while removing its entire plugin system. So I think "not updating" is definitely the right call here; longer-term we should move to Zensical.

@johnzhou721
Copy link
Copy Markdown
Contributor

FWIW: It's possible to suppress the other warning from Material as well if it's desirable to do so. I'm unsure of where the literate-nav warning is suppressed in the current codebase, so I'm posting the instructoins here: https://squidfunk.github.io/mkdocs-material/blog/2026/02/18/mkdocs-2.0/#what-this-means-for-you — in the blue box is the instructions. We need to set export NO_MKDOCS_2_WARNING=1.

@freakboy3742
Copy link
Copy Markdown
Member

FTR: The fix is in tox.ini. Look for DISABLE_MKDOCS_2_WARNING. Apparently we need to have both because .... Reasons (tm).

@johnzhou721
Copy link
Copy Markdown
Contributor

FTR: The fix is in tox.ini. Look for DISABLE_MKDOCS_2_WARNING. Apparently we need to have both because .... Reasons (tm).

I've opened #211 on this repo; I think we should be disabling this on other repos whenever we make other doc changes, as I don't have the capacity to make a lot of PRs.

@freakboy3742
Copy link
Copy Markdown
Member

I'd actively encourage you to not create PRs - because this is a really good activity for first time contributors, and we're heading into the PyCon US sprints.

@johnzhou721
Copy link
Copy Markdown
Contributor

@freakboy3742 Thanks. Should I close #211 since it's already done and other contributors can work on it?

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.

3 participants