chimcla.util_doc

Module to prepare and execute the generation of documentation (via sphinx).

used by some chimcla ... commands.

Module Contents

Classes

DocumentationGenerator

Functions

generate_module_docs
get_number_of_lines
get_wrapped_quoted_docstring
make_html_doc
continuously_build_docs	Watch file system changes (by polling) and trigger build on changes.

Data

FILE_NAME

API

chimcla.util_doc.FILE_NAME

None

chimcla.util_doc.generate_module_docs(package_path: str | None = None, output_dir: str | None = None)

chimcla.util_doc.get_number_of_lines(package_path, module_name)

chimcla.util_doc.get_wrapped_quoted_docstring(module_docstring, qq)

chimcla.util_doc.make_html_doc(docfile=None)

class chimcla.util_doc.DocumentationGenerator

Bases: watchdog.events.FileSystemEventHandler

on_modified(event)

dispatch(event: watchdog.events.FileSystemEvent) → None

on_any_event(event: watchdog.events.FileSystemEvent) → None

on_moved(event: watchdog.events.DirMovedEvent | watchdog.events.FileMovedEvent) → None

on_created(event: watchdog.events.DirCreatedEvent | watchdog.events.FileCreatedEvent) → None

on_deleted(event: watchdog.events.DirDeletedEvent | watchdog.events.FileDeletedEvent) → None

on_closed(event: watchdog.events.FileClosedEvent) → None

on_closed_no_write(event: watchdog.events.FileClosedNoWriteEvent) → None

on_opened(event: watchdog.events.FileOpenedEvent) → None

chimcla.util_doc.continuously_build_docs()

Watch file system changes (by polling) and trigger build on changes.

Use CTRL-C to cancel.