-
Notifications
You must be signed in to change notification settings - Fork 1
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 m2r2 instead of m2r #164
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I built the documentation in both HTML and PDF, which was a smooth process with a correct result. Looks good!
There were two error messages during the build that were not introduced by these changes, but seem to have been revealed by newly improved error checking. They seem pretty minor, would it be possible to correct them as part of this PR? If not, not problem, I'll just make a new issue.
- mismatched single quotes around
attribute=value
on line 4 ofdoc/source/api/api-overview.md
; the quotes should both be backticks. Results in a nonsensical link. - the paragraph that begins "When requesting streamflow data from a point" in
doc/source/workflow.md
has spaces at the beginning of the last few lines of the paragraph. Results in a weird indented section for no discernable reason.
I can make those changes first thing tomorrow and add them to this pull request |
Whoops, found one more bit of screwy help formatting, also in Moving the 1990 to the previous line would fix this, I think. Sorry for dumping a bunch of unrelated changes on you, thanks for making the helpfile building so much easier! |
I think that should solve the problems |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great.
This pull request resolves #130
It looks like m2r is no longer maintained but I found m2r2 which is forked off the original m2r repository and it seems to work with sphinx version > 3 although I'm not 100% confident on what the expected output is when you run
python setup.py build_sphinx
...