From e76965d24bdc990c89828d2a1ac3fedd36031ceb Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Fri, 16 Feb 2024 09:22:49 +0900 Subject: [PATCH] Fix sphinx apidoc exclude --- docs/source/conf.py | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 16ed7a669..8e3d42ab3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -207,7 +207,7 @@ def __call__(self, filename): # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build', 'test.py', "../../src/pynwb/retinotopy.py",] +exclude_patterns = ['_build', 'test.py'] # List of patterns, relative to source directory, of modules to be # excluded by apidoc when generating rst files. @@ -215,13 +215,6 @@ def __call__(self, filename): "../../src/pynwb/retinotopy.py", ] -# # This value contains a list of modules to be mocked up. This is useful -# # when some external dependencies are not met at build time and break the -# # building process. -# autodoc_mock_imports = [ -# 'pynwb.retinotopy', -# ] - # The reST default role (used for this markup: `text`) to use for all documents. # default_role = None @@ -424,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]) + 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