Skip to main content

renderer

PackageSource

The centralized renderer used to produce the Markdown format of the documentation.

Modules​

Member
Description
componentsThe implementation of the component synthesizer.
saverThe saver used for dumping output files.
resourcesRendering the resource files into the documentation.
pageThe synthesis of an API documentation page.
packageWalkthrough a python package, and render the package docstrings as the mdx-formatted API documentation.

Aliases​

Member
Description
render_objRender an arbitrary object as a documentation page.
render_package_as_mdxRender a package as MDX documentation files.