summaryrefslogtreecommitdiff
path: root/tools/refguide_check.py
diff options
context:
space:
mode:
authorTyler Reddy <tyler.je.reddy@gmail.com>2019-01-15 09:48:28 -0800
committerGitHub <noreply@github.com>2019-01-15 09:48:28 -0800
commit49689f7be478fe9a4d33761b080eb6aef3f8f899 (patch)
treedda8360b2ea5bcddf5b53854d86a0484065ced4c /tools/refguide_check.py
parentaddbf60f39fb5be5af8a6c2bba9dbf9039a6b18d (diff)
parent7fea4027fb85f8347af6c2e7e319f41a0603891f (diff)
downloadnumpy-49689f7be478fe9a4d33761b080eb6aef3f8f899.tar.gz
Merge pull request #12727 from mattip/gh-8067
DOC: fix and doctest tutorial
Diffstat (limited to 'tools/refguide_check.py')
-rw-r--r--tools/refguide_check.py6
1 files changed, 5 insertions, 1 deletions
diff --git a/tools/refguide_check.py b/tools/refguide_check.py
index fec715f63..531eeacb0 100644
--- a/tools/refguide_check.py
+++ b/tools/refguide_check.py
@@ -67,6 +67,7 @@ BASE_MODULE = "numpy"
PUBLIC_SUBMODULES = [
'core',
+ 'doc.structured_arrays',
'f2py',
'linalg',
'lib',
@@ -194,6 +195,9 @@ def get_all_dict(module):
all_dict.remove(name)
except ValueError:
pass
+ if not all_dict:
+ # Must be a pure documentation module like doc.structured_arrays
+ all_dict.append('__doc__')
# Modules are almost always private; real submodules need a separate
# run of refguide_check.
@@ -309,7 +313,7 @@ def validate_rst_syntax(text, name, dots=True):
ok_unknown_items = set([
'mod', 'currentmodule', 'autosummary', 'data',
'obj', 'versionadded', 'versionchanged', 'module', 'class',
- 'ref', 'func', 'toctree', 'moduleauthor',
+ 'ref', 'func', 'toctree', 'moduleauthor', 'term', 'c:member',
'sectionauthor', 'codeauthor', 'eq', 'doi', 'DOI', 'arXiv', 'arxiv'
])