MODULE

MKAPI.CORE.PAGE

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

Classes
dataclass

mkapi.core.page.Page(source, abs_src_path, abs_api_paths=<factory>, filters=<factory>)

Page class works with MkapiPlugin.

Parameters
  • source (str) Markdown source.
  • abs_src_path (str) Absolute source path of Markdown.
  • abs_api_paths (list of str, optional) A list of API paths.
  • filters (list of str, optional)
Attributes
  • abs_api_paths (list of str) A list of API paths.
  • abs_src_path (str) Absolute source path of Markdown.
  • filters (list of str)
  • headings (list of (int, str))
  • markdown (str) Converted Markdown including API documentation.
  • nodes (list of Node or Code) A list of Node instances.
Methods
method

content(html) → str

Returns updated HTML to MkapiPlugin.

Parameters
  • html (str) Input HTML converted by MkDocs.