summaryrefslogtreecommitdiff
path: root/tools/refguide_check.py
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2020-05-05 18:27:46 -0700
committerRoss Barnowski <rossbar@berkeley.edu>2020-05-05 18:27:46 -0700
commit0efcd156244969d40c5b1af59204abbc684d3835 (patch)
tree45ae3434eec7e3af5ebf52efa4b9bd225d8a55af /tools/refguide_check.py
parent1a5462651bbf61adcf1816f2253eeca2b26ca162 (diff)
downloadnumpy-0efcd156244969d40c5b1af59204abbc684d3835.tar.gz
BLD: Add :doc: to whitelisted roles in refguide_check.
The refguide_check (which currently runs as part of the CI) fails on :doc: roles in the documentation. Added :doc: to the set of whitelisted role names as it is a valid role in sphinx.
Diffstat (limited to 'tools/refguide_check.py')
-rw-r--r--tools/refguide_check.py2
1 files changed, 1 insertions, 1 deletions
diff --git a/tools/refguide_check.py b/tools/refguide_check.py
index e6cfc8b77..31d2997d3 100644
--- a/tools/refguide_check.py
+++ b/tools/refguide_check.py
@@ -450,7 +450,7 @@ def validate_rst_syntax(text, name, dots=True):
return False, "ERROR: %s: no documentation" % (name,)
ok_unknown_items = set([
- 'mod', 'currentmodule', 'autosummary', 'data', 'attr',
+ 'mod', 'doc', 'currentmodule', 'autosummary', 'data', 'attr',
'obj', 'versionadded', 'versionchanged', 'module', 'class',
'ref', 'func', 'toctree', 'moduleauthor', 'term', 'c:member',
'sectionauthor', 'codeauthor', 'eq', 'doi', 'DOI', 'arXiv', 'arxiv'