kiara.doc¶
Main module for code that helps with documentation auto-generation in supported projects.
FrklDocumentationPlugin
¶
mkdocs plugin to render API documentation for a project.
To add to a project, add this to the 'plugins' section of a mkdocs config file:
- frkl-docgen:
main_module: "module_name"
This will add an API reference
navigation item to your page navigation, with auto-generated entries for every
Python module in your package.