Source code for sectiondoc.sections.attributes

# -*- coding: utf-8 -*-
#-----------------------------------------------------------------------------
#  License: LICENSE.TXT
#  Author: Ioannis Tziakos
#
#  Copyright (c) 2011-2014, Enthought, Inc.
#  All rights reserved.
#-----------------------------------------------------------------------------
from sectiondoc.items import DefinitionItem
from sectiondoc.renderers import Attribute


[docs]def attributes(doc, header, renderer=Attribute, item_class=DefinitionItem): """Render the attributes section to sphinx friendly format. Arguments --------- doc : DocRender The docstring container. header : string This parameter is ignored in this method. renderer : Renderer A renderer instance to render the items. item_class : type The item parser class to use. Default is :class:`~.orDefinitionItem`. """ items = doc.extract_items(item_class) lines = [] renderer = renderer() for item in items: renderer.item = item lines += renderer.to_rst() lines.append('') return lines