Bump documentation website dependencies #169
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
per1234
added
topic: infrastructure
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The project's documentation is published in a MkDocs-based website:
https://arduino.github.io/arduino-fwuploader/dev/
One of the Python packages that is a transitive dependency of the website framework was recently updated (#168). This caused a regression in the way the website renders fenced code blocks.
Before that pymdown-extensions package update, the fenced code blocks were rendered as expected:
https://arduino.github.io/arduino-fwuploader/2.2/commands/arduino-fwuploader/#options
after the pymdown-extensions package update they were rendered incorrectly:
https://arduino.github.io/arduino-fwuploader/dev/commands/arduino-fwuploader/#options
I didn't identify the specific reason why this happened, but I did find that it was fixed by updating the mkdocs-material package dependency. While I was at it, I also updated the other MkDocs-related package dependencies of the website as they were all significantly outdated and experience (including this one) shows that they are best updated in parallel.
You can see a demonstration of how the website will look after the changes proposed here are applied here where I deployed it in my fork:
https://per1234.github.io/arduino-fwuploader/dev/commands/arduino-fwuploader/#options