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

Upgrade mkdocs-material #38

Merged
merged 21 commits into from
Oct 6, 2023
Merged

Upgrade mkdocs-material #38

merged 21 commits into from
Oct 6, 2023

Conversation

jtherrmann
Copy link
Contributor

@jtherrmann jtherrmann commented Oct 2, 2023

See #27 for context

How to test these changes locally:

  • cd into your local clone of mkdocs-asf-theme.
  • Pull the latest changes and switch to the upgrade-mkdocs-material branch.
  • cd into your local clone of hyp3-docs.
  • Pull the latest changes and switch to the upgrade-theme branch.
  • Activate the hyp3-docs virtual environment and run pip install -e ../mkdocs-asf-theme/.
  • Run mkdocs serve.

You can make changes to mkdocs-asf-theme and then display them on the hyp3-docs website by Ctrl+Cing and re-running mkdocs serve.

@jtherrmann jtherrmann marked this pull request as draft October 2, 2023 20:49
@jtherrmann jtherrmann marked this pull request as ready for review October 4, 2023 19:07
@jtherrmann
Copy link
Contributor Author

Moving remaining TODOs to #39

@jtherrmann
Copy link
Contributor Author

Moving remaining style differences to #40

Copy link
Contributor

@jhkennedy jhkennedy left a comment

Choose a reason for hiding this comment

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

Looks good for develop -- I think we'll want to have a discussion about the range of mkdocs-material we support before releasing.

@@ -31,7 +31,7 @@

install_requires=[
'mkdocs',
'mkdocs-material>=6.2.1,<7.0',
'mkdocs-material==9.4.2',
Copy link
Contributor

Choose a reason for hiding this comment

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

@jtherrmann do we want to be this strict with the material version, or constrain to the major version?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No idea, we should discuss this further.

@jtherrmann jtherrmann merged commit d4edd49 into develop Oct 6, 2023
2 of 3 checks passed
@jtherrmann jtherrmann deleted the upgrade-mkdocs-material branch October 6, 2023 01:32
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.

2 participants