Skip to content

Commit

Permalink
Exclude pynwb retinotopy from sphinx apidoc (#1846)
Browse files Browse the repository at this point in the history
* Exclude pynwb retinotopy from sphinx

* Update conf.py

* Update conf.py

* Update conf.py

* Fix sphinx apidoc exclude
  • Loading branch information
rly authored Feb 16, 2024
1 parent d59fe07 commit 90d6b1d
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,12 @@ def __call__(self, filename):
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'test.py']

# List of patterns, relative to source directory, of modules to be
# excluded by apidoc when generating rst files.
apidoc_exclude = [
"../../src/pynwb/retinotopy.py",
]

# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None

Expand Down Expand Up @@ -411,7 +417,8 @@ def run_apidoc(_):
out_dir = os.path.dirname(__file__)
src_dir = os.path.join(out_dir, '../../src')
sys.path.append(src_dir)
apidoc_main(['-f', '-e', '--no-toc', '-o', out_dir, src_dir])
apidoc_exclude_abs = [os.path.join(out_dir, f) for f in apidoc_exclude]
apidoc_main(['-f', '-e', '--no-toc', '-o', out_dir, src_dir, *apidoc_exclude_abs])


from abc import abstractproperty
Expand Down

0 comments on commit 90d6b1d

Please sign in to comment.