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.

Sign up for GitHub

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

Jump to bottom

Replace m2r with a package that is maintained #795

Open
JulioAPeraza opened this issue May 2, 2023 · 1 comment
Open

Replace m2r with a package that is maintained #795

JulioAPeraza opened this issue May 2, 2023 · 1 comment
Assignees
@JulioAPeraza
Labels
enhancement New feature or request

Comments

@JulioAPeraza
Copy link
Collaborator

Summary

Switch from m2r to m2r2 or sphinx-mdinclude.

Additional details

m2r was archived and thus no longer maintained. That also prevents us to upgrade mistune, which is used by other dependencies.

NiMARE/setup.cfg

Lines 64 to 67 in 4ceb358

doc =
m2r
matplotlib
mistune<2 # just temporary until m2r addresses this issue

Next steps

Switch to m2r2 or sphinx-mdinclude. sphinx-mdinclude at least works with mistune 2.x.
@JulioAPeraza JulioAPeraza added the enhancement New feature or request label May 2, 2023
@jdkent
Copy link
Member

jdkent commented May 3, 2023

I do not have a strong opinion, m2r2 has more stars, but sphinx-mdinclude appears to be more focused as a sphinx-extension which is our use-case

@JulioAPeraza JulioAPeraza self-assigned this Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JulioAPeraza JulioAPeraza

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jdkent @JulioAPeraza