autodoc: change :novalue: to :annoation: option

The :novalue: option is now called :annotation: and has an additional feature:
When given with an argument, you can specify what the annotation
of the object will be.

1 files changed, 25 insertions, 6 deletions

diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py
index 2bdba7e4f..07758e3c9 100644
--- a/sphinx/ext/autodoc.py
+++ b/sphinx/ext/autodoc.py
@@ -85,6 +85,15 @@ def members_set_option(arg):
         return ALL
     return set(x.strip() for x in arg.split(','))
 
+SUPPRESS = object()
+
+def annotation_option(arg):
+    if arg is None:
+        # suppress showing the representation of the object
+        return SUPPRESS
+    else:
+        return arg
+
 def bool_option(arg):
     """Used to convert flag options to auto directives.  (Instead of
     directives.flag(), which returns None).
@@ -1097,8 +1106,8 @@ class DataDocumenter(ModuleLevelDocumenter):
     objtype = 'data'
     member_order = 40
     priority = -10
-    option_spec = ModuleLevelDocumenter.option_spec
-    option_spec["novalue"] = bool_option
+    option_spec = dict(ModuleLevelDocumenter.option_spec)
+    option_spec["annotation"] = annotation_option
 
     @classmethod
     def can_document_member(cls, member, membername, isattr, parent):
@@ -1106,13 +1115,18 @@ class DataDocumenter(ModuleLevelDocumenter):
 
     def add_directive_header(self, sig):
         ModuleLevelDocumenter.add_directive_header(self, sig)
-        if not self.options.novalue:
+        if not self.options.annotation:
             try:
                 objrepr = safe_repr(self.object)
             except ValueError:
                 pass
             else:
                 self.add_line(u'   :annotation: = ' + objrepr, '<autodoc>')
+        elif self.options.annotation is SUPPRESS:
+            pass
+        else:
+            self.add_line(u'   :annotation: %s' % self.options.annotation,
+                          '<autodoc>')
 
     def document_members(self, all_members=False):
         pass
@@ -1184,8 +1198,8 @@ class AttributeDocumenter(ClassLevelDocumenter):
     """
     objtype = 'attribute'
     member_order = 60
-    option_spec = ModuleLevelDocumenter.option_spec
-    option_spec["novalue"] = bool_option
+    option_spec = dict(ModuleLevelDocumenter.option_spec)
+    option_spec["annotation"] = annotation_option
 
     # must be higher than the MethodDocumenter, else it will recognize
     # some non-data descriptors as methods
@@ -1221,13 +1235,18 @@ class AttributeDocumenter(ClassLevelDocumenter):
 
     def add_directive_header(self, sig):
         ClassLevelDocumenter.add_directive_header(self, sig)
-        if not self._datadescriptor and not self.options.novalue:
+        if not self._datadescriptor and not self.options.annotation:
             try:
                 objrepr = safe_repr(self.object)
             except ValueError:
                 pass
             else:
                 self.add_line(u'   :annotation: = ' + objrepr, '<autodoc>')
+        elif self.options.annotation is SUPPRESS:
+            pass
+        else:
+            self.add_line(u'   :annotation: %s' % self.options.annotation,
+                          '<autodoc>')
 
     def add_content(self, more_content, no_docstring=False):
         if not self._datadescriptor: