summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohannes Dewender <bitbucket@JonnyJD.net>2013-01-22 17:58:45 +0100
committerJohannes Dewender <bitbucket@JonnyJD.net>2013-01-22 17:58:45 +0100
commitcf58cbc4e16e1d5e58cd2e361df6e69aa451ac6e (patch)
tree91d8641859084cde845a62ff31e11f5cc5beaa9a
parent2725068ad0ae80a0d2ee37ad5e81901266f595db (diff)
downloadsphinx-cf58cbc4e16e1d5e58cd2e361df6e69aa451ac6e.tar.gz
autodoc: novalue option for autodata and autoattribute
This adds a ":novalue:" option to "autodata" and "autoattribute" from the autodoc extension. When the option is set, no value will be in the output.
-rw-r--r--sphinx/ext/autodoc.py19
1 files changed, 12 insertions, 7 deletions
diff --git a/sphinx/ext/autodoc.py b/sphinx/ext/autodoc.py
index 45dbdcdb..4181818b 100644
--- a/sphinx/ext/autodoc.py
+++ b/sphinx/ext/autodoc.py
@@ -1097,6 +1097,8 @@ class DataDocumenter(ModuleLevelDocumenter):
objtype = 'data'
member_order = 40
priority = -10
+ option_spec = ModuleLevelDocumenter.option_spec
+ option_spec["novalue"] = bool_option
@classmethod
def can_document_member(cls, member, membername, isattr, parent):
@@ -1104,12 +1106,13 @@ class DataDocumenter(ModuleLevelDocumenter):
def add_directive_header(self, sig):
ModuleLevelDocumenter.add_directive_header(self, sig)
- try:
- objrepr = safe_repr(self.object)
- except ValueError:
- pass
- else:
- self.add_line(u' :annotation: = ' + objrepr, '<autodoc>')
+ if not "novalue" in self.options:
+ try:
+ objrepr = safe_repr(self.object)
+ except ValueError:
+ pass
+ else:
+ self.add_line(u' :annotation: = ' + objrepr, '<autodoc>')
def document_members(self, all_members=False):
pass
@@ -1181,6 +1184,8 @@ class AttributeDocumenter(ClassLevelDocumenter):
"""
objtype = 'attribute'
member_order = 60
+ option_spec = ModuleLevelDocumenter.option_spec
+ option_spec["novalue"] = bool_option
# must be higher than the MethodDocumenter, else it will recognize
# some non-data descriptors as methods
@@ -1216,7 +1221,7 @@ class AttributeDocumenter(ClassLevelDocumenter):
def add_directive_header(self, sig):
ClassLevelDocumenter.add_directive_header(self, sig)
- if not self._datadescriptor:
+ if not self._datadescriptor or "novalue" in self.options:
try:
objrepr = safe_repr(self.object)
except ValueError: