sphinx.ext.autodoc.PropertyDocumenter

class documentation

class PropertyDocumenter(DocstringStripSignatureMixin, ClassLevelDocumenter): (source)

View In Hierarchy

Specialized Documenter subclass for properties.

Class Method can_document_member Called to see if a member can be documented by this Documenter.
Method add_directive_header Add the directive header and options to the generated content.
Method document_members Generate reST for member documentation.
Method get_real_modname Get the real module name of an object to document.
Method import_object Check the exisitence of uninitialized instance attribute when failed to import the attribute.
Class Variable member_order Undocumented
Class Variable objtype Undocumented
Class Variable priority Undocumented
Instance Variable isclassmethod Undocumented
Instance Variable object Undocumented

Inherited from DocstringStripSignatureMixin:

Method format_signature Undocumented
Instance Variable retann Undocumented

Inherited from DocstringSignatureMixin (via DocstringStripSignatureMixin):

Method get_doc Undocumented
Instance Variable args Undocumented
Method _find_signature Undocumented
Instance Variable _new_docstrings Undocumented
Instance Variable _signatures Undocumented

Inherited from ClassLevelDocumenter (via DocstringStripSignatureMixin, DocstringSignatureMixin):

Method resolve_name Resolve the module and name of the object to document given by the arguments and the current module/class.

Inherited from Documenter (via DocstringStripSignatureMixin, DocstringSignatureMixin, ClassLevelDocumenter):

Method __init__ Undocumented
Method add_content Add content from docstrings, attribute documentation and user.
Method add_line Append one line of generated reST to the output.
Method check_module Check if *self.object* is really defined in the module given by *self.modname*.
Method filter_members Filter the given member list.
Method format_args Format the argument signature of *self.object*.
Method format_name Format the name of *self.object*.
Method generate Generate reST for the object given by *self.name*, and possibly for its members.
Method get_attr getattr() override for types such as Zope interfaces.
Method get_object_members Return `(members_check_module, members)` where `members` is a list of `(membername, member)` pairs of the members of *self.object*.
Method get_sourcename Undocumented
Method parse_name Determine what module to import and what attribute to document.
Method process_doc Let the user process the docstrings before adding them.
Method sort_members Sort the given member list.
Class Variable content_indent Undocumented
Class Variable option_spec Undocumented
Class Variable titles_allowed Undocumented
Instance Variable analyzer Undocumented
Instance Variable config Undocumented
Instance Variable directive Undocumented
Instance Variable env Undocumented
Instance Variable fullname Undocumented
Instance Variable indent Undocumented
Instance Variable modname Undocumented
Instance Variable module Undocumented
Instance Variable name Undocumented
Instance Variable object_name Undocumented
Instance Variable objpath Undocumented
Instance Variable options Undocumented
Instance Variable parent Undocumented
Instance Variable real_modname Undocumented
Property documenters Returns registered Documenter classes
Method _call_format_args Undocumented
@classmethod
def can_document_member(cls, member, membername, isattr, parent): (source)
overrides sphinx.ext.autodoc.Documenter.can_document_member

Called to see if a member can be documented by this Documenter.

Parameters
member:AnyUndocumented
membername:strUndocumented
isattr:boolUndocumented
parent:AnyUndocumented
Returns
boolUndocumented
def add_directive_header(self, sig): (source)
overrides sphinx.ext.autodoc.Documenter.add_directive_header

Add the directive header and options to the generated content.

Parameters
sig:strUndocumented
def document_members(self, all_members=False): (source)
overrides sphinx.ext.autodoc.Documenter.document_members

Generate reST for member documentation. If *all_members* is True, document all members, else those given by *self.options.members*.

Parameters
all_members:boolUndocumented
def get_real_modname(self): (source)
overrides sphinx.ext.autodoc.Documenter.get_real_modname

Get the real module name of an object to document. It can differ from the name of the module through which the object was imported.

Returns
strUndocumented
def import_object(self, raiseerror=False): (source)
overrides sphinx.ext.autodoc.Documenter.import_object

Check the exisitence of uninitialized instance attribute when failed to import the attribute.

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
member_order: int = (source)
overrides sphinx.ext.autodoc.Documenter.member_order

Undocumented

objtype: str = (source)
overrides sphinx.ext.autodoc.Documenter.objtype

Undocumented

priority = (source)
overrides sphinx.ext.autodoc.Documenter.priority

Undocumented

isclassmethod: bool = (source)

Undocumented

object = (source)
overrides sphinx.ext.autodoc.Documenter.object

Undocumented