# {py:mod}`localecmddoc.autodoc`

```{py:module} localecmddoc.autodoc
```

```{autodoc2-docstring} localecmddoc.autodoc
:allowtitles:
```

## Module Contents

### Functions

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

* - {py:obj}`write_module_docs <localecmddoc.autodoc.write_module_docs>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.write_module_docs
    :summary:
    ```
* - {py:obj}`write_file <localecmddoc.autodoc.write_file>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.write_file
    :summary:
    ```
* - {py:obj}`create_module_doc_output <localecmddoc.autodoc.create_module_doc_output>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.create_module_doc_output
    :summary:
    ```
* - {py:obj}`fill_md_directive <localecmddoc.autodoc.fill_md_directive>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.fill_md_directive
    :summary:
    ```
* - {py:obj}`getdoc_topic <localecmddoc.autodoc.getdoc_topic>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.getdoc_topic
    :summary:
    ```
* - {py:obj}`getdoc_cmd <localecmddoc.autodoc.getdoc_cmd>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.getdoc_cmd
    :summary:
    ```
* - {py:obj}`translate_parameters <localecmddoc.autodoc.translate_parameters>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.translate_parameters
    :summary:
    ```
* - {py:obj}`remove_injected_argument <localecmddoc.autodoc.remove_injected_argument>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.remove_injected_argument
    :summary:
    ```
* - {py:obj}`remove_python_code_blocks <localecmddoc.autodoc.remove_python_code_blocks>`
  - ```{autodoc2-docstring} localecmddoc.autodoc.remove_python_code_blocks
    :summary:
    ```
````

### API

````{py:function} write_module_docs(modules: typing.Iterable[localecmd.Module], output_folder: pathlib.Path, file_extension: str = '.md', *, remove_pycode: bool = True)
:canonical: localecmddoc.autodoc.write_module_docs

```{autodoc2-docstring} localecmddoc.autodoc.write_module_docs
```
````

````{py:function} write_file(file: pathlib.Path, txt: str)
:canonical: localecmddoc.autodoc.write_file

```{autodoc2-docstring} localecmddoc.autodoc.write_file
```
````

````{py:function} create_module_doc_output(module: localecmd.Module, *, remove_pycode: bool) -> str
:canonical: localecmddoc.autodoc.create_module_doc_output

```{autodoc2-docstring} localecmddoc.autodoc.create_module_doc_output
```
````

````{py:function} fill_md_directive(directive: str, content: str, arg: str) -> str
:canonical: localecmddoc.autodoc.fill_md_directive

```{autodoc2-docstring} localecmddoc.autodoc.fill_md_directive
```
````

````{py:function} getdoc_topic(topic: localecmd.topic.Topic, directive: str) -> str
:canonical: localecmddoc.autodoc.getdoc_topic

```{autodoc2-docstring} localecmddoc.autodoc.getdoc_topic
```
````

````{py:function} getdoc_cmd(cmd: localecmd.Function, directive: str, *, remove_pycode: bool) -> str
:canonical: localecmddoc.autodoc.getdoc_cmd

```{autodoc2-docstring} localecmddoc.autodoc.getdoc_cmd
```
````

````{py:function} translate_parameters(s: str, fullname: str = '')
:canonical: localecmddoc.autodoc.translate_parameters

```{autodoc2-docstring} localecmddoc.autodoc.translate_parameters
```
````

````{py:function} remove_injected_argument(s: str, remove_arg: str) -> str
:canonical: localecmddoc.autodoc.remove_injected_argument

```{autodoc2-docstring} localecmddoc.autodoc.remove_injected_argument
```
````

````{py:function} remove_python_code_blocks(s: str) -> str
:canonical: localecmddoc.autodoc.remove_python_code_blocks

```{autodoc2-docstring} localecmddoc.autodoc.remove_python_code_blocks
```
````