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

use myst_parser instead of m2r2 #125

Merged
merged 5 commits into from
Jan 2, 2025
Merged

use myst_parser instead of m2r2 #125

merged 5 commits into from
Jan 2, 2025

Conversation

toloudis
Copy link
Collaborator

@toloudis toloudis commented Nov 19, 2024

m2r2 is a Sphinx plugin parser for markdown format.
m2r2 is no longer actively maintained, and one of its dependencies, docutils has updated and now breaks m2r2.
See this build script failure: https://github.com/AllenCellModeling/aicspylibczi/actions/runs/11921902785

It was either pin docutils or try something new. myst_parser is a more current replacement.

@toloudis toloudis marked this pull request as ready for review November 20, 2024 00:12
Copy link
Collaborator

@evamaxfield evamaxfield left a comment

Choose a reason for hiding this comment

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

Thanks for making the switch!

Choose a reason for hiding this comment

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

Great idea

@toloudis toloudis merged commit d4bb4aa into main Jan 2, 2025
21 checks passed
@toloudis toloudis deleted the fix/docs-replace-m2r2 branch January 2, 2025 17:17
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.

4 participants