pydoctor.epydoc2stan

module documentation

Convert pydoctor.epydoc parsed markup into renderable content.

Class	`Field`	Like `pydoctor.epydoc.markup.Field`, but without the gross accessor methods and with a formatted body.
Class	`FieldDesc`	Combines informations from multiple `Field` objects into one.
Class	`FieldHandler`	No class docstring; 0/13 instance variable, 2/22 methods, 0/1 static method documented
Class	`KeywordArgument`	Encapsulate the name of `kwarg` parameters.
Class	`RaisesDesc`	Description of an exception that can be raised by function/method.
Class	`VariableArgument`	Encapsulate the name of `vararg` parameters.
Function	`extract_fields`	Populate Attributes for module/class variables using fields from that module/class's docstring. Must only be called for objects that have a docstring.
Function	`format_constant_value`	Should be only called for `Attribute` objects that have the `Attribute.value` property set.
Function	`format_desc_list`	Format list of `FieldDesc`. Used for param, returns, raises, etc.
Function	`format_docstring`	Generate an HTML representation of a docstring
Function	`format_field_list`	Format list of `Field` object. Used for notes, see also, authors, etc.
Function	`format_kind`	Transform a `model.DocumentableKind` Enum value to string.
Function	`format_summary`	Generate an shortened HTML representation of a docstring.
Function	`format_undocumented`	Generate an HTML representation for an object lacking a docstring.
Function	`get_docstring`	Undocumented
Function	`get_parsed_type`	Undocumented
Function	`get_parser`	Get the `parse_docstring(str, List[ParseError], bool) -> ParsedDocstring` function.
Function	`parse_docstring`	No summary
Function	`reportErrors`	Undocumented
Function	`taglink`	Undocumented
Function	`type2stan`	Undocumented
Variable	`field_name_to_kind`	Undocumented
Class	`_EpydocLinker`	No class docstring; 0/1 instance variable, 2/7 methods documented
Function	`_format_constant_value`	Undocumented
Function	`_is_none_literal`	Does this AST node represent the literal constant None?

def extract_fields(obj):

Populate Attributes for module/class variables using fields from that module/class's docstring. Must only be called for objects that have a docstring.

Parameters
obj:`model.Documentable`	Undocumented

def format_constant_value(obj):

Should be only called for Attribute objects that have the Attribute.value property set.

Parameters
obj:`model.Attribute`	Undocumented
Returns
`Flattenable`	Undocumented

def format_desc_list(label, descs):

Format list of FieldDesc. Used for param, returns, raises, etc.

Generates a 2-columns layout as follow:

    +------------------------------------+
    | <label>                            |
    | <name>: <type> |     <desc>        |
    | <name>: <type> |     <desc>        |
    +------------------------------------+

If the fields don't have type or name information, generates the same output as format_field_list:

    +------------------------------------+
    | <label>                            |
    | <desc ... >                        |
    +------------------------------------+

Parameters
label:`str`	Section "mini heading"
descs:`Sequence[FieldDesc]`	`FieldDesc`s
Returns
`Iterator[Tag]`	Each row as iterator or None if no `descs` id provided.

def format_docstring(obj):

Generate an HTML representation of a docstring

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Tag`	Undocumented

def format_field_list(singular, plural, fields):

Format list of Field object. Used for notes, see also, authors, etc.

Generates a 2-columns layout as follow:

    +------------------------------------+
    | <label>                            |
    | <desc ... >                        |
    +------------------------------------+

Parameters
singular:`str`	Undocumented
plural:`str`	Undocumented
fields:`Sequence[Field]`	Undocumented
Returns
`Iterator[Tag]`	Each row as iterator

def format_kind(kind, plural=False):

Transform a `model.DocumentableKind` Enum value to string.

Parameters
kind:`model.DocumentableKind`	Undocumented
plural:`bool`	Undocumented
Returns
`str`	Undocumented

def format_summary(obj):

Generate an shortened HTML representation of a docstring.

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Tag`	Undocumented

def format_undocumented(obj):

Generate an HTML representation for an object lacking a docstring.

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Tag`	Undocumented

def get_docstring(obj):

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Tuple[Optional[str], Optional[model.Documentable]]`	Undocumented

def get_parsed_type(obj):

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Optional[ParsedDocstring]`	Undocumented

def get_parser(obj):

Get the parse_docstring(str, List[ParseError], bool) -> ParsedDocstring function.

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Callable[[str, List[ParseError], bool], ParsedDocstring]`	Undocumented

def parse_docstring(obj, doc, source):

Parse a docstring.

Parameters
obj:`model.Documentable`	The object we're parsing the documentation for.
doc:`str`	The docstring.
source:`model.Documentable`	The object on which the docstring is defined. This can differ from `obj` if the docstring is inherited.
Returns
`ParsedDocstring`	Undocumented

def reportErrors(obj, errs):

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
errs:`Sequence[ParseError]`	Undocumented

def taglink(o, page_url, label=None):

Undocumented

Parameters
o:`model.Documentable`	Undocumented
page_url:`str`	Undocumented
label:`Optional[Flattenable]`	Undocumented
Returns
`Tag`	Undocumented

def type2stan(obj):

Undocumented

Parameters
obj:`model.Documentable`	Undocumented
Returns
`Optional[Tag]`	Undocumented

field_name_to_kind =

Undocumented

def _format_constant_value(obj):

Undocumented

Parameters
obj:`model.Attribute`	Undocumented
Returns
`Iterator[Flattenable]`	Undocumented

def _is_none_literal(node):

Does this AST node represent the literal constant None?

Parameters
node:`ast.expr`	Undocumented
Returns
`bool`	Undocumented