File tree 5 files changed +18
-0
lines changed
5 files changed +18
-0
lines changed Original file line number Diff line number Diff line change @@ -284,6 +284,9 @@ jobs:
284
284
command : |
285
285
apt-get update
286
286
apt-get install -y graphviz
287
+ - run :
288
+ name : Install Requirements (may contain pinned versions)
289
+ command : python -m pip install -r docs/requirements.txt
287
290
- run :
288
291
name : Install fMRIPrep
289
292
command : python -m pip install ".[doc]"
Original file line number Diff line number Diff line change 1
1
version : 2
2
2
3
3
python :
4
+ version : 3.7
4
5
install :
6
+ - requirements : docs/requirements.txt
5
7
- method : pip
6
8
path : .
7
9
extra_requirements :
Original file line number Diff line number Diff line change 44
44
'sphinxarg.ext' , # argparse extension
45
45
'nipype.sphinxext.plot_workflow' ,
46
46
'nbsphinx' ,
47
+ 'sphinxcontrib.napoleon' ,
47
48
]
48
49
49
50
# Mock modules in autodoc:
63
64
# Add any paths that contain templates here, relative to this directory.
64
65
templates_path = ['_templates' ]
65
66
67
+ # Accept custom section names to be parsed for numpy-style docstrings
68
+ # of parameters.
69
+ # Requires pinning sphinxcontrib-napoleon to a specific commit while
70
+ # https://github.com/sphinx-contrib/napoleon/pull/10 is merged.
71
+ napoleon_use_param = False
72
+ napoleon_custom_sections = [
73
+ ('Inputs' , 'Parameters' ),
74
+ ('Outputs' , 'Parameters' ),
75
+ ]
76
+
66
77
# The suffix(es) of source filenames.
67
78
# You can specify multiple suffix as a list of string:
68
79
# source_suffix = ['.rst', '.md']
Original file line number Diff line number Diff line change
1
+ git+https://github.com/AleksandarPetrov/napoleon.git@0dc3f28a309ad602be5f44a9049785a1026451b3#egg=sphinxcontrib-napoleon
Original file line number Diff line number Diff line change 58
58
sphinx >=1.5.3
59
59
sphinx-argparse
60
60
sphinx_rtd_theme
61
+ sphinxcontrib-napoleon
61
62
docs =
62
63
%(doc)s
63
64
duecredit = duecredit
You can’t perform that action at this time.
0 commit comments