Skip to content

Commit 23a8eee

Browse files
committed
fix(docs): add missing extension napoleon
1 parent 5e136dd commit 23a8eee

File tree

5 files changed

+18
-0
lines changed

5 files changed

+18
-0
lines changed

Diff for: .circleci/config.yml

+3
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,9 @@ jobs:
284284
command: |
285285
apt-get update
286286
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
287290
- run:
288291
name: Install fMRIPrep
289292
command: python -m pip install ".[doc]"

Diff for: .readthedocs.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
version: 2
22

33
python:
4+
version: 3.7
45
install:
6+
- requirements: docs/requirements.txt
57
- method: pip
68
path: .
79
extra_requirements:

Diff for: docs/conf.py

+11
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@
4444
'sphinxarg.ext', # argparse extension
4545
'nipype.sphinxext.plot_workflow',
4646
'nbsphinx',
47+
'sphinxcontrib.napoleon',
4748
]
4849

4950
# Mock modules in autodoc:
@@ -63,6 +64,16 @@
6364
# Add any paths that contain templates here, relative to this directory.
6465
templates_path = ['_templates']
6566

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+
6677
# The suffix(es) of source filenames.
6778
# You can specify multiple suffix as a list of string:
6879
# source_suffix = ['.rst', '.md']

Diff for: docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
git+https://github.com/AleksandarPetrov/napoleon.git@0dc3f28a309ad602be5f44a9049785a1026451b3#egg=sphinxcontrib-napoleon

Diff for: setup.cfg

+1
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ doc =
5858
sphinx >=1.5.3
5959
sphinx-argparse
6060
sphinx_rtd_theme
61+
sphinxcontrib-napoleon
6162
docs =
6263
%(doc)s
6364
duecredit = duecredit

0 commit comments

Comments
 (0)