Mikedoc API Reference

November 29, 2024 ยท View on GitHub

Here are modules that make up Mikedoc:

mikedoc.__init__
This module exposes public functions and classes useful for most cases.

mikedoc.browser.__init__
This module exposes function for browsing the codebase, and iterating/inspecting modules

mikedoc.builder.__init__
The Builder class and the build function are defined in this module.

mikedoc.cli.__init__
The command-line interface class is defined here

mikedoc.errors.__init__
No docstring.

mikedoc.misc.__init__
Misc stuff. The parse_docstring function is defined in this module.

Back to top