Merge PR #9073: [sphinx] No more undocumented objects.

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 (“{+ …}”,