openstack
/
heat
Code Issues Proposed changes

Fix SupportStatus msg appearing in doc generating 

SupportStatus message is omitted when status equals
SUPPORTED. Also, patch adds SupportStatus note to
attribute schema.

Change-Id: I63160b21f9043e5a8d9cd35b4825c5d9abd9a6ed
Closes-bug: #1434454
This commit is contained in:
Peter Razumovsky 2015-03-20 12:15:20 +03:00
parent c824153e4f
commit abb59d290f
1 changed files with 18 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
doc/source/ext/resources.py
View File

@ -58,11 +58,7 @@ class ResourcePages(compat.Directive):
self.attrs_schemata = attributes.schemata( self.attrs_schemata = attributes.schemata(
self.resource_class.attributes_schema) self.resource_class.attributes_schema)
if resource_class.support_status.status == support.DEPRECATED: self._status_str(resource_class.support_status, section)
para = nodes.paragraph('', self._status_str(
resource_class.support_status))
note = nodes.note('', para)
section.append(note)
cls_doc = pydoc.getdoc(resource_class) cls_doc = pydoc.getdoc(resource_class)
if cls_doc: if cls_doc:
@ -70,13 +66,6 @@ class ResourcePages(compat.Directive):
cls_nodes = core.publish_doctree(cls_doc).children cls_nodes = core.publish_doctree(cls_doc).children
section.extend(cls_nodes) section.extend(cls_nodes)
if (resource_class.support_status.status == support.SUPPORTED and
resource_class.support_status.version is not None):
tag = resource_class.support_status.version.title()
message = (_('Available since %s.') % self._version_str(tag))
para = nodes.paragraph('', message)
section.append(para)
self.contribute_properties(section) self.contribute_properties(section)
self.contribute_attributes(section) self.contribute_attributes(section)
@ -88,20 +77,27 @@ class ResourcePages(compat.Directive):
def _version_str(self, version): def _version_str(self, version):
if version in _CODE_NAMES: if version in _CODE_NAMES:
return "%(version)s (%(code)s)" % {'version': version, return _("%(version)s (%(code)s)") % {'version': version,
'code': _CODE_NAMES[version]} 'code': _CODE_NAMES[version]}
else: else:
return version return version
def _status_str(self, support_status): def _status_str(self, support_status, section):
sstatus = support_status.to_dict() sstatus = support_status.to_dict()
msg = sstatus['status'] if sstatus['status'] is support.SUPPORTED:
msg = _('Available')
else:
msg = sstatus['status']
if sstatus['version'] is not None: if sstatus['version'] is not None:
msg += ' since %s' % self._version_str(sstatus['version']) msg = _('%s since %s') % (msg,
self._version_str(sstatus['version']))
if sstatus['message'] is not None: if sstatus['message'] is not None:
msg += ' - %s' % sstatus['message'] msg = _('%s - %s') % (msg, sstatus['message'])
if not (sstatus['status'] is support.SUPPORTED and
return msg sstatus['version'] is None):
para = nodes.paragraph(_(''), msg)
note = nodes.note(_(''), para)
section.append(note)
def _section(self, parent, title, id_pattern): def _section(self, parent, title, id_pattern):
id = id_pattern % self.resource_type id = id_pattern % self.resource_type
@ -232,18 +228,7 @@ Resources:
definition = nodes.definition() definition = nodes.definition()
prop_item.append(definition) prop_item.append(definition)
if prop.support_status.status != support.SUPPORTED: self._status_str(prop.support_status, definition)
para = nodes.paragraph('', self._status_str(prop.support_status))
note = nodes.note('', para)
definition.append(note)
if (prop.support_status.status == support.SUPPORTED and
prop.support_status.version is not None):
tag = prop.support_status.version.title()
message = (_('Available since %s.') % self._version_str(tag))
para = nodes.paragraph('', message)
note = nodes.note('', para)
definition.append(note)
if not prop.implemented: if not prop.implemented:
para = nodes.paragraph('', _('Not implemented.')) para = nodes.paragraph('', _('Not implemented.'))
@ -331,11 +316,7 @@ Resources:
definition = nodes.definition() definition = nodes.definition()
prop_item.append(definition) prop_item.append(definition)
if prop.support_status.status != support.SUPPORTED: self._status_str(prop.support_status, definition)
para = nodes.paragraph('',
self._status_str(prop.support_status))
note = nodes.note('', para)
definition.append(note)
if description: if description:
def_para = nodes.paragraph('', description) def_para = nodes.paragraph('', description)