generate_documentation

omni.graph.tools.ogn.generate_documentation(

configuration: GeneratorConfiguration,

) → str | None

Create support files for the documentation of a node

Parameters:

configuration – Information defining how and where the documentation will be generated

Returns:

String containing the generated documentation or None if its generation was not enabled

Raises:

NodeGenerationError – When there is a failure in the generation of the documentation file