Mkdocs updates to allow community PRs to pass the build.yml check/workflow #690
Conversation
This file contains 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
Update Dockerfile to use mkdocs-material
Update build.yml for mkdocs
Update requirements.txt with mkdocs & dependencies
Update publish-docker-pr.yml for mkdocs
Update publish-docker-master.yml with mkdocs
Fixing mkdocs build --strict issues:
INFO - DeprecationWarning: 'materialx.emoji.twemoji' is deprecated.
Material emoji logic has been officially moved into mkdocs-material
version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
as mkdocs_material_extensions is deprecated and will no longer be
supported moving forward. This is the last release.
File "/home/default/.local/lib/python3.10/site-packages/materialx/emoji.py", line 106, in twemoji
return _patch_index(options)
File "/home/default/.local/lib/python3.10/site-packages/materialx/emoji.py", line 59, in _deprecated_func
warnings.warn(
WARNING - Material emoji logic has been officially moved into mkdocs-material
version 9.4. Please use Material's 'material.extensions.emoji.twemoji'
as mkdocs_material_extensions is deprecated and will no longer be
supported moving forward. This is the last release.
WARNING - Config value 'plugins': Plugin 'material/social' option 'cards_color': Deprecated, use 'cards_layout_options.background_color' and 'cards_layout_options.color' with 'default' layout
Update requirements.txt with material[imaging]
Testing mkdocs workflow change
Update Dockerfile mkdocs
Update Dockerfile w/ pip upgrade
Update Dockerfile pip commands
Fixing mistake
qwahzi
changed the title
Remove extra pip install on deploy-staging.yml to mirror the publish workflows
Remove extra pip install on deploy.yml to mirror publish workflows
Update Dockerfile to squidfunk/mkdocs-material
Update publish-docker-master.yml with squidfunk/mkdocs-material:latest
…th squidfunk/mkdocs-material:latest Update publish-docker-pr.yml with Update publish-docker-master.yml with squidfunk/mkdocs-material:latest
Remove old theme info from readme.md
thsfs
requested changes
Nov 22, 2023
Update Dockerfile to use digest
Update image to use digest
Use sha256 digest
thsfs
approved these changes
Nov 22, 2023
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.
This PR updates mkdocs to the latest standard version, resolves deprecated mkdocs config options (
materialx.emoji.twemojiandsocial.cards_color), & allows the build workflow to run/pass for community PRsThe next/final step to allowing community PRs to pass the build checks (specifically the publish jobs) will probably be to update the Dockerfile & publish workflows to use a standard mkdocs image as well