Skip to content

Commit b6c95cb

Browse files
committed
fix(docs): do not generate autodoc for dmriprep.config.testing
1 parent c4941f1 commit b6c95cb

File tree

4 files changed

+11
-6
lines changed

4 files changed

+11
-6
lines changed

docs/Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ help:
5252
clean:
5353
rm -rf $(BUILDDIR)/*
5454
rm -rf reference/*
55+
rm -rf api/
5556

5657
html:
5758
PYTHONPATH=$(PYTHONPATH) $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

docs/conf.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,10 @@
9797
exclude_patterns = [
9898
'_build', 'Thumbs.db', '.DS_Store',
9999
'api/dmriprep.rst',
100-
'api/dmriprep.cli.rst', 'api/dmriprep.cli.*.rst']
100+
'api/dmriprep.cli.rst',
101+
'api/dmriprep.cli.*.rst',
102+
'api/dmriprep.config.testing.rst',
103+
]
101104

102105
# The name of the Pygments (syntax highlighting) style to use.
103106
pygments_style = None
@@ -211,7 +214,7 @@
211214

212215
apidoc_module_dir = '../dmriprep'
213216
apidoc_output_dir = 'api'
214-
apidoc_excluded_paths = ['conftest.py', '*/tests/*', 'tests/*', 'data/*']
217+
apidoc_excluded_paths = ['conftest.py', '*/tests/*', 'tests/*', 'data/*', 'config/testing.py']
215218
apidoc_separate_modules = True
216219
apidoc_extra_args = ['--module-first', '-d 1', '-T']
217220

docs/requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ sphinx-argparse
1111
sphinx>=2.1.2
1212
sphinx_rtd_theme
1313
sphinxcontrib-apidoc ~= 0.3.0
14-
templateflow
14+
templateflow
15+
toml

setup.cfg

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@ parentdir_prefix =
101101
[flake8]
102102
max-line-length = 99
103103
doctests = False
104-
exclude=
104+
ignore =
105+
W503
106+
exclude =
105107
*build/
106108
*/.afq/*
107109
docs/
108-
ignore =
109-
W503
110110

111111
[tool:pytest]
112112
norecursedirs = .* _*

0 commit comments

Comments
 (0)