PACKAGE

MKAPI.CORE

Package level documentation is written in __init__.py.

This module provides functions that inspect attributes from source code.

Functions
  • get_attributes(obj) (dict(str: (any, str))) Returns a dictionary that maps attribute name to a tuple of (type, description).</>
  • get_class_attributes(cls) (dict(str: (any, str))) Returns a dictionary that maps attribute name to a tuple of (type, description).</>
  • get_dataclass_attributes(cls) (dict(str: (any, str))) Returns a dictionary that maps attribute name to a tuple of (type, description).</>
  • get_module_attributes(module) (dict(str: (any, str))) Returns a dictionary that maps attribute name to a tuple of (type, description).</>

This module provides entity classes to represent docstring structure.

Classes

This module provides Code class for source code.

Classes
  • Code Code class represents source code of an object.</>
Functions

This module provides functions that parse docstring.

Functions

This module implements the functionality of docstring inheritance.

Functions
  • get_bases(node) (Node, iterator of Node) Yields a tuple of (Node instance, iterator of Node).</>
  • get_section(node, name, mode) (Section) Returns a tuple of (docstring section, signature section).</>
  • inherit(node) Inherits Parameters and Attributes from superclasses.</>
  • inherit_base(node, base, name) Inherits Parameters or Attributes section from base class.</>
  • is_complete(node, name) (bool) Returns True if docstring is complete.</>

This module provides functions that relate to link.

Functions
  • get_link(obj, include_module) (str) Returns Markdown link for object, if possible.</>
  • link(name, href) (str) Reutrns Markdown link with a mark that indicates this link was created by MkApi.</>
  • replace_link(obj, markdown) (str) Returns a replaced link with object full name.</>
  • resolve_link(markdown, abs_src_path, abs_api_paths) (str) Reutrns resolved link.</>
  • resolve_object(html) (dict(str: any)) Reutrns an object context dictionary.</>

This modules provides Module class that has tree structure.

Classes
  • Module Module class represents a module.</>
Functions

This modules provides Node class that has tree structure.

Classes
  • Node Node class represents an object.</>
Functions
  • get_node(name, sourcefile_index) (Node) Returns a Node instace by name or object.</>
  • is_member(obj, name, sourcefiles) (int) Returns an integer thats indicates if obj is a member or not.</>

This module provides utility functions that relate to object.

Functions

This module provides a Page class that works with other converter.

Classes

This module provides Renderer class that renders Node instance to create API documentation.

Attributes
  • renderer (Renderer) Renderer instance that can be used globally.
Classes
  • Renderer Renderer instance renders Node instance recursively to create API documentation.</>

This module provides Signature class that inspects object and creates signature and types.

Classes
Functions
  • a_of_b(annotation, obj) (str) Returns A of B style string.</>
  • resolve_forward_ref(obj, name) (str) Returns a resolved name for typing.ForwardRef.</>
  • to_string(annotation, kind, obj) (str) Returns string expression of annotation.</>
  • to_string_args(annotation, obj) (str) Returns a string for callable and generator annotation.</>
  • union(annotation, obj) (str) Returns a string for union annotation.</>

This module provides base class of Node and Module.

Classes