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

m2r is broken #410

Closed
ZryletTC opened this issue Apr 10, 2020 · 2 comments · Fixed by #417
Closed

m2r is broken #410

ZryletTC opened this issue Apr 10, 2020 · 2 comments · Fixed by #417
Assignees

Comments

@ZryletTC
Copy link
Contributor

ZryletTC commented Apr 10, 2020

Docs aren't building because m2r is stale and fallen behind compatibility with the sphinx API.

Possible solutions:

  • Could be fixed by m2r#55
  • If desired, can be bypassed for now by pinning sphinx<3.0.0 or specifying the hotfix branch of m2r
  • Realistically, that PR will never be merged as the repo has been inactive since 2018 so a better course of action would probably be to drop m2r and switch to recommonmark as others are doing

Originally posted by @ZryletTC in #400 (comment)

@ZLLentz
Copy link
Member

ZLLentz commented Apr 10, 2020

I heard murmurs of sphinx making incompatible changes... My vote is always to either drop the dependency and do the docs a different way or to switch to a maintained package.

@klauer
Copy link
Contributor

klauer commented Apr 10, 2020

We use recommonmark in pytmc and have it suggested in the ci-helpers module. I don't recall it having ever gotten in the way.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants