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

MkDocs version reverted to a previous version #1424

Open
Sreekala-Gopakumar opened this issue Oct 9, 2024 · 1 comment
Open

MkDocs version reverted to a previous version #1424

Sreekala-Gopakumar opened this issue Oct 9, 2024 · 1 comment
Assignees

Comments

@Sreekala-Gopakumar
Copy link
Contributor

Sreekala-Gopakumar commented Oct 9, 2024

In the OpenJ9 user guide, there are some options that are clubbed together as a single topic but in the mkdocs.yml file we have given different option names pointing to the same topic. Earlier, the TOC used to show the options as we have listed in the .yml file, but after a build, it was showing the first option name for a topic as specified in the .yml file multiple times for some reason. Till 0.43.0 release, it was fine.

Screenshot 2024-07-23 at 6 48 56 PM

On investigating this matter, this was because of mkdocs version 1.6.1 (specified in the requirements.txt). This issue was reported in the following issues:

mkdocs/mkdocs#3710
squidfunk/mkdocs-material#7411

The issue is not yet fixed. The workaround is to revert to mkdocs version 1.5.3 and because of this version change, we had to revert the mkdocs-material version to 9.5.29 from 9.5.34 (because 1.5.3 is not compatible with 9.5.3 and later).

#1423 - Revert MkDocs version 1.6.1 to 1.5.3

Even though in the local machine mkdocs-material 9.5.29 worked, it showed compatibility issue on merging. On Peter's suggestion, changed the version to 9.5.18. According to https://squidfunk.github.io/mkdocs-material/changelog/ we could use at the latest 9.5.18, since 9.5.19 added the requirement for mkdocs 1.6

#1425

If this issue is fixed in mkdocs, we will have to update the versions. This issue will be closed only after that.

@Sreekala-Gopakumar Sreekala-Gopakumar self-assigned this Oct 9, 2024
@pshipton
Copy link
Member

The published docs for 0.47 are updated.

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

No branches or pull requests

2 participants