-
Notifications
You must be signed in to change notification settings - Fork 262
DOC: Update Sphinx config to support recent Sphinx/numpydoc #749
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
Conversation
This fixes the build. Anybody up for a review? |
Codecov Report
@@ Coverage Diff @@
## maint/2.4.x #749 +/- ##
============================================
Coverage 88.36% 88.36%
============================================
Files 188 188
Lines 23998 23998
Branches 4258 4258
============================================
Hits 21207 21207
- Misses 2102 2103 +1
+ Partials 689 688 -1
Continue to review full report at Codecov.
|
Doing some cleanup PRs, so will merge this to fix tests tomorrow if nobody reviews by then. |
Incidentally, I would suggest reviewing as follows: nibabel$ virtualenv --python=python venv
nibabel$ source venv/bin/activate
nibabel$ pip install -r doc-requirements.txt
nibabel$ make html
nibabel$ firefox file://$PWD/build/html/index.html |
Builds fine for me using this environment. Anything specific I should be looking for?
|
(Although |
Mostly just looking through the docs for if anything looks off (or really, different from https://nipy.org/nibabel/). |
I clicked around randomly, and checked these pages in more detail (covering inline images, code and maths, and auto-generated API docs):
All looks good to me! |
Thanks for the second pair of eyes! |
Builds are breaking on master due to the numpydoc 0.9.0 release and numpy/numpydoc#210. We have an old constraint keeping us at Sphinx < 1.6 (added a4a667d), which is exactly the new minimum version required by numpydoc. I've tested with removing the constraint and LaTeX support seems to have been restored.
Additional changes:
html_sidebar
options have been updated, and the old options deprecated at 2.0, so the new config/template maintains the current sidebar.mock
import, so I just added it to the dependencies.