Skip to content

Commit

Permalink
Merge pull request #116 from poldracklab/docs/sphinx-build-revision
Browse files Browse the repository at this point in the history
DOC: Update sphinx to latest major (4.0)
  • Loading branch information
oesteban authored Jun 29, 2021
2 parents 54097ca + 9c6a54e commit 96250df
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 17 deletions.
17 changes: 4 additions & 13 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,14 @@
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.coverage",
"sphinx.ext.doctest",
"sphinx.ext.githubpages",
"sphinx.ext.ifconfig",
"sphinx.ext.intersphinx",
"sphinx.ext.coverage",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.githubpages",
"sphinxcontrib.apidoc",
]

autodoc_mock_imports = [
Expand All @@ -55,16 +54,8 @@

# Accept custom section names to be parsed for numpy-style docstrings
# of parameters.
# Requires pinning sphinxcontrib-napoleon to a specific commit while
# https://github.com/sphinx-contrib/napoleon/pull/10 is merged.
napoleon_use_param = True
napoleon_custom_sections = [
# ("Inputs", "params_style"),
# ("Outputs", "Parameters"),
# ("Attributes", "Parameters"),
# ("Mandatory Inputs", "Parameters"),
# ("Optional Inputs", "Parameters"),
]
napoleon_custom_sections = []

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
Expand Down
6 changes: 2 additions & 4 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
git+https://github.com/rwblair/sphinxcontrib-versioning.git@39b40b0b84bf872fc398feff05344051bbce0f63#egg=sphinxcontrib-versioning
nbsphinx
packaging
pydot>=1.2.3
pydotplus
sphinx-argparse
sphinx~=3.2.1
sphinx_rtd_theme
sphinxcontrib-apidoc
sphinx ~= 4.0
sphinx_rtd_theme

0 comments on commit 96250df

Please sign in to comment.