Skip to content

Writing a Python plugin page

Use this directory for documentation contributed by an optional uLib library. Name the public page after the module, for example my_plugin.md for uLib.MyPlugin.

Start with module availability, then list every public pybind class, enum, and function. Give a short executable-looking example for each constructible class and state clearly when a type is abstract, returned by another API, or only available in gcompose.

Keep Recipes and assets in a sibling directory named after the module when a single page is no longer enough. Register the resulting page in docs/python/plugins.md and mkdocs.yml.