aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorThéo Zimmermann2018-11-25 13:12:12 +0100
committerThéo Zimmermann2018-12-14 09:14:41 +0100
commit321a17fcc3ed9d22699913ebb789b9a4063b6ff4 (patch)
treef2316eb42533d626ba1e84b8868a26b69cfde910 /doc
parent7e3603069cf591c6c70ef25d4cfc72f62aa44058 (diff)
Do not raise object without body warning for prodn objects.
Diffstat (limited to 'doc')
-rw-r--r--doc/tools/coqrst/coqdomain.py37
1 files changed, 21 insertions, 16 deletions
diff --git a/doc/tools/coqrst/coqdomain.py b/doc/tools/coqrst/coqdomain.py
index 2c69dcfe08..827b7c13c1 100644
--- a/doc/tools/coqrst/coqdomain.py
+++ b/doc/tools/coqrst/coqdomain.py
@@ -198,6 +198,25 @@ class CoqObject(ObjectDescription):
self._add_index_entry(name, target)
return target
+ def _prepare_names(self):
+ sigs = self.get_signatures()
+ names = self.options.get("name")
+ if names is None:
+ self._names = {}
+ else:
+ names = [n.strip() for n in names.split(";")]
+ if len(names) != len(sigs):
+ ERR = ("Expected {} semicolon-separated names, got {}. " +
+ "Please provide one name per signature line.")
+ raise self.error(ERR.format(len(names), len(sigs)))
+ self._names = dict(zip(sigs, names))
+
+ def run(self):
+ self._prepare_names()
+ return super().run()
+
+class DocumentableObject(CoqObject):
+
def _warn_if_undocumented(self):
document = self.state.document
config = document.settings.env.config
@@ -212,30 +231,16 @@ class CoqObject(ObjectDescription):
if report == "warning":
raise self.warning(msg)
- def _prepare_names(self):
- sigs = self.get_signatures()
- names = self.options.get("name")
- if names is None:
- self._names = {}
- else:
- names = [n.strip() for n in names.split(";")]
- if len(names) != len(sigs):
- ERR = ("Expected {} semicolon-separated names, got {}. " +
- "Please provide one name per signature line.")
- raise self.error(ERR.format(len(names), len(sigs)))
- self._names = dict(zip(sigs, names))
-
def run(self):
self._warn_if_undocumented()
- self._prepare_names()
return super().run()
-class PlainObject(CoqObject):
+class PlainObject(DocumentableObject):
"""A base class for objects whose signatures should be rendered literally."""
def _render_signature(self, signature, signode):
signode += addnodes.desc_name(signature, signature)
-class NotationObject(CoqObject):
+class NotationObject(DocumentableObject):
"""A base class for objects whose signatures should be rendered as nested boxes.
Objects that inherit from this class can use the notation grammar (“{+ …}”,