OBPIH-6197 update mkdocs kit and related doc#4924
Merged
jmiranda merged 2 commits intoopenboxes:OBPIH-6197from Nov 1, 2024
Merged
OBPIH-6197 update mkdocs kit and related doc#4924jmiranda merged 2 commits intoopenboxes:OBPIH-6197from
jmiranda merged 2 commits intoopenboxes:OBPIH-6197from
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
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.
Update mkdocs setup to use current release of mkdocs and associated packages.
Remove partial version dependencies in docs/requirements.txt that are currently broken per current README.md. Attempts to follow README.md and run mkdocs produced this error:
This issue can be fixed if we specifiy 'materialx==0.0.0.dev1' in requirements.txt, but this then produces a page or two of deprecation warnings about a change in materialx.
-- doc/requirements.txt is updated to remove all revision specifications and use the latest releases of mkdocs and its dependencies.
-- mkdocs.yml is updated per the instructions in the deprecation warnings.
-- docs/README.md is updated to recommend use of a python virtual environment when creating the mkdocs config.