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

Remove m2r dependency from docs #46

Closed
SigmaX opened this issue Apr 7, 2020 · 3 comments
Closed

Remove m2r dependency from docs #46

SigmaX opened this issue Apr 7, 2020 · 3 comments
Labels
bug Something isn't working

Comments

@SigmaX
Copy link
Collaborator

SigmaX commented Apr 7, 2020

We're using the m2r Sphinx plugin to pull our README.md into the docs' "Quickstart Guide" page. Handy.

Unfortunately, m2r is in archive mode, and recent updates to Sphinx have deprecated an argument that breaks people's docs builds if they use m2r: sphinx-doc/sphinx#7420

We should seek an alternative, or be content to maintain a separate README and quickstart guide.

@SigmaX SigmaX added the bug Something isn't working label Apr 7, 2020
@wlievens
Copy link

wlievens commented May 4, 2020

Any update on this? I'm not sure how to fix my build now.

@SigmaX
Copy link
Collaborator Author

SigmaX commented May 25, 2020

Hi @wlievens — for our project here, we're probably going to just stop using m2r entirely. Looks like people over on the Sphinx thread have figured out a fix, though, so you might check out the comments there: sphinx-doc/sphinx#7420

@wlievens
Copy link

Thanks for the info. I got it to work eventually.

@SigmaX SigmaX closed this as completed Oct 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants