Skip to content

Commit 96250df

Browse files
authored
Merge pull request #116 from poldracklab/docs/sphinx-build-revision
DOC: Update sphinx to latest major (4.0)
2 parents 54097ca + 9c6a54e commit 96250df

File tree

2 files changed

+6
-17
lines changed

2 files changed

+6
-17
lines changed

docs/conf.py

+4-13
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,14 @@
2929
# -- General configuration ---------------------------------------------------
3030
extensions = [
3131
"sphinx.ext.autodoc",
32+
"sphinx.ext.coverage",
3233
"sphinx.ext.doctest",
34+
"sphinx.ext.githubpages",
35+
"sphinx.ext.ifconfig",
3336
"sphinx.ext.intersphinx",
34-
"sphinx.ext.coverage",
3537
"sphinx.ext.mathjax",
3638
"sphinx.ext.napoleon",
37-
"sphinx.ext.ifconfig",
3839
"sphinx.ext.viewcode",
39-
"sphinx.ext.githubpages",
40-
"sphinxcontrib.apidoc",
4140
]
4241

4342
autodoc_mock_imports = [
@@ -55,16 +54,8 @@
5554

5655
# Accept custom section names to be parsed for numpy-style docstrings
5756
# of parameters.
58-
# Requires pinning sphinxcontrib-napoleon to a specific commit while
59-
# https://github.com/sphinx-contrib/napoleon/pull/10 is merged.
6057
napoleon_use_param = True
61-
napoleon_custom_sections = [
62-
# ("Inputs", "params_style"),
63-
# ("Outputs", "Parameters"),
64-
# ("Attributes", "Parameters"),
65-
# ("Mandatory Inputs", "Parameters"),
66-
# ("Optional Inputs", "Parameters"),
67-
]
58+
napoleon_custom_sections = []
6859

6960
# Add any paths that contain templates here, relative to this directory.
7061
templates_path = ["_templates"]

docs/requirements.txt

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
git+https://github.com/rwblair/sphinxcontrib-versioning.git@39b40b0b84bf872fc398feff05344051bbce0f63#egg=sphinxcontrib-versioning
21
nbsphinx
32
packaging
43
pydot>=1.2.3
54
pydotplus
65
sphinx-argparse
7-
sphinx~=3.2.1
8-
sphinx_rtd_theme
9-
sphinxcontrib-apidoc
6+
sphinx ~= 4.0
7+
sphinx_rtd_theme

0 commit comments

Comments
 (0)