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

downgraded mkdocstrings[python] in requirements_docs.txt #354

Closed
wants to merge 2 commits into from

Conversation

nh916
Copy link
Contributor

@nh916 nh916 commented Sep 18, 2023

Description

  • downgraded mkdocstrings[python] because 0.23.0 is buggy
  • upgraded mkdocs package because new one is available and working well

Changes

mkdocstrings[python] Package

downgraded documentation package from mkdocstrings[python]==0.23.0 to mkdocstrings[python]==0.22.0

mkdocstrings[python]==0.23.0 does not support hot reload which is annoying and causing issues when updating the documentation and checking how it looks in the browser. Downgrading it now and will come back to it when it works fine.

mkdocs Package

upgraded mkdocs to newest release and everything seems to be working fine

Known Issues

Notes

Left them an issue for them to be aware of and hopefully, they'll fix it soon.
mkdocstrings/mkdocstrings#614

Checklist

  • My name is on the list of contributors (CONTRIBUTORS.md) in the pull request source branch.
  • I have updated the documentation to reflect my changes.

downgraded documentation package  from `mkdocstrings[python]==0.23.0` to `mkdocstrings[python]==0.22.0`

mkdocstrings[python]==0.23.0 does not support hot reload which is annoying and causing issues when updating the documentation and checking how it looks in the browser. Downgrading it now and will come back to it when it works fine.
@trunk-io
Copy link

trunk-io bot commented Sep 18, 2023

Merging to develop in this repository is managed by Trunk.

  • To merge this pull request, check the box to the left or comment /trunk merge below.

@nh916 nh916 requested a review from InnocentBug September 18, 2023 22:30
@nh916 nh916 closed this Sep 19, 2023
@nh916 nh916 deleted the downgrade-buggy-package-update branch September 19, 2023 19:15
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.

1 participant