doc_handler

Classes

DocHandler

DocHandler(context: CodeGenContext)

Responsible for generating documentation and supporting assets.

Functions

emit

emit(save_path: Path)

Generate documentation and supporting assets.

Parameters:

• save_path

  (Path) –

  Path to save the generated code.

Functions

generate_html_docs

generate_html_docs(context: CodeGenContext, save_path: Path)

Generate offline html documentation site.

Parameters:

• context

  (CodeGenContext) –

  (CodeGenContext): Code generation context.

• save_path

  (Path) –

  Path to save the generated code.

generate_license

generate_license(context: CodeGenContext, save_path: Path)

Generate module license file.

Parameters:

• context

  (CodeGenContext) –

  (CodeGenContext): Code generation context.

• save_path

  (Path) –

  Path to save the generated code.

generate_readme

generate_readme(context: CodeGenContext, save_path: Path)

Generate the README markdown file.

Parameters:

• context

  (CodeGenContext) –

  (CodeGenContext): Code generation context.

• save_path

  (Path) –

  Path to save the generated code.