# {py:mod}`chimcla.util_doc`

```{py:module} chimcla.util_doc
```

```{autodoc2-docstring} chimcla.util_doc
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`DocumentationGenerator <chimcla.util_doc.DocumentationGenerator>`
  -
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`generate_module_docs <chimcla.util_doc.generate_module_docs>`
  - ```{autodoc2-docstring} chimcla.util_doc.generate_module_docs
    :summary:
    ```
* - {py:obj}`get_number_of_lines <chimcla.util_doc.get_number_of_lines>`
  - ```{autodoc2-docstring} chimcla.util_doc.get_number_of_lines
    :summary:
    ```
* - {py:obj}`get_wrapped_quoted_docstring <chimcla.util_doc.get_wrapped_quoted_docstring>`
  - ```{autodoc2-docstring} chimcla.util_doc.get_wrapped_quoted_docstring
    :summary:
    ```
* - {py:obj}`make_html_doc <chimcla.util_doc.make_html_doc>`
  - ```{autodoc2-docstring} chimcla.util_doc.make_html_doc
    :summary:
    ```
* - {py:obj}`continuously_build_docs <chimcla.util_doc.continuously_build_docs>`
  - ```{autodoc2-docstring} chimcla.util_doc.continuously_build_docs
    :summary:
    ```
````

### Data

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`FILE_NAME <chimcla.util_doc.FILE_NAME>`
  - ```{autodoc2-docstring} chimcla.util_doc.FILE_NAME
    :summary:
    ```
````

### API

````{py:data} FILE_NAME
:canonical: chimcla.util_doc.FILE_NAME
:value: >
   None

```{autodoc2-docstring} chimcla.util_doc.FILE_NAME
```

````

````{py:function} generate_module_docs(package_path: str | None = None, output_dir: str | None = None)
:canonical: chimcla.util_doc.generate_module_docs

```{autodoc2-docstring} chimcla.util_doc.generate_module_docs
```
````

````{py:function} get_number_of_lines(package_path, module_name)
:canonical: chimcla.util_doc.get_number_of_lines

```{autodoc2-docstring} chimcla.util_doc.get_number_of_lines
```
````

````{py:function} get_wrapped_quoted_docstring(module_docstring, qq)
:canonical: chimcla.util_doc.get_wrapped_quoted_docstring

```{autodoc2-docstring} chimcla.util_doc.get_wrapped_quoted_docstring
```
````

````{py:function} make_html_doc(docfile=None)
:canonical: chimcla.util_doc.make_html_doc

```{autodoc2-docstring} chimcla.util_doc.make_html_doc
```
````

`````{py:class} DocumentationGenerator
:canonical: chimcla.util_doc.DocumentationGenerator

Bases: {py:obj}`watchdog.events.FileSystemEventHandler`

````{py:method} on_modified(event)
:canonical: chimcla.util_doc.DocumentationGenerator.on_modified

````

````{py:method} dispatch(event: watchdog.events.FileSystemEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.dispatch

````

````{py:method} on_any_event(event: watchdog.events.FileSystemEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_any_event

````

````{py:method} on_moved(event: watchdog.events.DirMovedEvent | watchdog.events.FileMovedEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_moved

````

````{py:method} on_created(event: watchdog.events.DirCreatedEvent | watchdog.events.FileCreatedEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_created

````

````{py:method} on_deleted(event: watchdog.events.DirDeletedEvent | watchdog.events.FileDeletedEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_deleted

````

````{py:method} on_closed(event: watchdog.events.FileClosedEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_closed

````

````{py:method} on_closed_no_write(event: watchdog.events.FileClosedNoWriteEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_closed_no_write

````

````{py:method} on_opened(event: watchdog.events.FileOpenedEvent) -> None
:canonical: chimcla.util_doc.DocumentationGenerator.on_opened

````

`````

````{py:function} continuously_build_docs()
:canonical: chimcla.util_doc.continuously_build_docs

```{autodoc2-docstring} chimcla.util_doc.continuously_build_docs
```
````