Skip to content

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

Merged
merged 1 commit into from
Apr 25, 2019

Conversation

effigies
Copy link
Member

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:

  • The html_sidebar options have been updated, and the old options deprecated at 2.0, so the new config/template maintains the current sidebar.
  • The autodoc module now triggers a mock import, so I just added it to the dependencies.

@effigies
Copy link
Member Author

This fixes the build. Anybody up for a review?

@codecov-io
Copy link

codecov-io commented Apr 23, 2019

Codecov Report

Merging #749 into maint/2.4.x will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             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
Impacted Files Coverage Δ
nibabel/cmdline/parrec2nii.py 32.73% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b58e204...cda524c. Read the comment docs.

@effigies
Copy link
Member Author

Doing some cleanup PRs, so will merge this to fix tests tomorrow if nobody reviews by then.

@effigies
Copy link
Member Author

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

@pauldmccarthy
Copy link
Contributor

Builds fine for me using this environment. Anything specific I should be looking for?

$ pip freeze
alabaster==0.7.12
Babel==2.6.0
certifi==2019.3.9
chardet==3.0.4
cycler==0.10.0
docutils==0.14
idna==2.8
imagesize==1.1.0
Jinja2==2.10.1
kiwisolver==1.0.1
MarkupSafe==1.1.1
matplotlib==3.0.3
mock==2.0.0
numpy==1.16.3
numpydoc==0.9.1
packaging==19.0
pbr==5.1.3
Pygments==2.3.1
pyparsing==2.4.0
python-dateutil==2.8.0
pytz==2019.1
requests==2.21.0
six==1.12.0
snowballstemmer==1.2.1
Sphinx==2.0.1
sphinxcontrib-applehelp==1.0.1
sphinxcontrib-devhelp==1.0.1
sphinxcontrib-htmlhelp==1.0.2
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.2
sphinxcontrib-serializinghtml==1.1.3
texext==0.6.1
urllib3==1.24.2

@pauldmccarthy
Copy link
Contributor

(Although kiwisolver==1.1.0 failed to compile on my mac, so I force-installed kiwisolver==1.0.1)

@effigies
Copy link
Member Author

Mostly just looking through the docs for if anything looks off (or really, different from https://nipy.org/nibabel/).

@pauldmccarthy
Copy link
Contributor

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!

@effigies
Copy link
Member Author

Thanks for the second pair of eyes!

@effigies effigies merged commit e7e3668 into nipy:maint/2.4.x Apr 25, 2019
@effigies effigies deleted the fix/numpydoc_0_9 branch April 25, 2019 15:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants