Skip to content

DOC: Sphinx 3 compatibility #3206

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 4 commits into from
Apr 18, 2020
Merged

DOC: Sphinx 3 compatibility #3206

merged 4 commits into from
Apr 18, 2020

Conversation

effigies
Copy link
Member

Summary

The :workflow: directive uses a deprecated API that was removed in Sphinx 3.

Fixes #3205.

List of changes proposed in this PR (pull-request)

Acknowledgment

  • (Mandatory) I acknowledge that this contribution will be available under the Apache 2 license.

@effigies
Copy link
Member Author

It looks like we don't use this directive anywhere, so there are no docs to check. Using nipreps/fmriprep#2092 to test.

@codecov
Copy link

codecov bot commented Apr 18, 2020

Codecov Report

Merging #3206 into master will increase coverage by 0.03%.
The diff coverage is 7.50%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3206      +/-   ##
==========================================
+ Coverage   64.85%   64.89%   +0.03%     
==========================================
  Files         301      301              
  Lines       39715    39717       +2     
  Branches     5268     5268              
==========================================
+ Hits        25759    25776      +17     
+ Misses      12894    12884      -10     
+ Partials     1062     1057       -5     
Flag Coverage Δ
#unittests 64.89% <7.50%> (+0.03%) ⬆️
Impacted Files Coverage Δ
nipype/sphinxext/plot_workflow.py 14.95% <7.50%> (+1.16%) ⬆️
nipype/pipeline/plugins/base.py 59.72% <0.00%> (+1.64%) ⬆️
nipype/pipeline/plugins/legacymultiproc.py 68.81% <0.00%> (+3.46%) ⬆️

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 a70ec99...6f15e26. Read the comment docs.

@satra
Copy link
Member

satra commented Apr 18, 2020

i think we were using it in nipype workflows which has moved to niflows.

@effigies
Copy link
Member Author

I don't think we're building the docs there, yet.

Functionality is preserved using the new API with Sphinx 2: https://13143-53175327-gh.circle-artifacts.com//0/tmp/src/fmriprep/docs/_build/html/workflows.html

@effigies
Copy link
Member Author

'external/*',
'fixes/*',
'scripts/*',
'sphinxext/*',
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed this line, and then black had to have this file.

We're now at least exercising the code in doc builds again, even if it won't show up in coverage. I'm going to merge.

@effigies effigies merged commit 28ef1af into nipy:master Apr 18, 2020
@effigies effigies deleted the doc/sphinx3 branch April 18, 2020 16:50
@effigies effigies added this to the 1.5.0 milestone Apr 19, 2020
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.

Sphinx 3 issues
2 participants