# {py:mod}`localecmddoc.codeblock`

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

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

## Module Contents

### Classes

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

* - {py:obj}`LocalecmdExample <localecmddoc.codeblock.LocalecmdExample>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExample
    :summary:
    ```
* - {py:obj}`LocalecmdExampleList <localecmddoc.codeblock.LocalecmdExampleList>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleList
    :summary:
    ```
* - {py:obj}`LocalecmdExampleDirective <localecmddoc.codeblock.LocalecmdExampleDirective>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleDirective
    :summary:
    ```
* - {py:obj}`LocalecmdExampleListDirective <localecmddoc.codeblock.LocalecmdExampleListDirective>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleListDirective
    :summary:
    ```
````

### Functions

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

* - {py:obj}`get_cli <localecmddoc.codeblock.get_cli>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.get_cli
    :summary:
    ```
* - {py:obj}`clean_example_dicts <localecmddoc.codeblock.clean_example_dicts>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.clean_example_dicts
    :summary:
    ```
* - {py:obj}`process_code_blocks <localecmddoc.codeblock.process_code_blocks>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.process_code_blocks
    :summary:
    ```
* - {py:obj}`run_codeblocks <localecmddoc.codeblock.run_codeblocks>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.run_codeblocks
    :summary:
    ```
* - {py:obj}`generate_example_list <localecmddoc.codeblock.generate_example_list>`
  - ```{autodoc2-docstring} localecmddoc.codeblock.generate_example_list
    :summary:
    ```
````

### API

````{py:function} get_cli(app: sphinx.application.Sphinx) -> localecmd.CLI
:canonical: localecmddoc.codeblock.get_cli

```{autodoc2-docstring} localecmddoc.codeblock.get_cli
```
````

````{py:class} LocalecmdExample(rawsource='', text='', *children, **attributes)
:canonical: localecmddoc.codeblock.LocalecmdExample

Bases: {py:obj}`docutils.nodes.General`, {py:obj}`docutils.nodes.FixedTextElement`

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExample
```

```{rubric} Initialization
```

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExample.__init__
```

````

````{py:class} LocalecmdExampleList(rawsource='', *children, **attributes)
:canonical: localecmddoc.codeblock.LocalecmdExampleList

Bases: {py:obj}`docutils.nodes.General`, {py:obj}`docutils.nodes.Element`

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleList
```

```{rubric} Initialization
```

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleList.__init__
```

````

````{py:class} LocalecmdExampleDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
:canonical: localecmddoc.codeblock.LocalecmdExampleDirective

Bases: {py:obj}`sphinx.util.docutils.SphinxDirective`

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleDirective
```

```{rubric} Initialization
```

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleDirective.__init__
```

````

````{py:class} LocalecmdExampleListDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
:canonical: localecmddoc.codeblock.LocalecmdExampleListDirective

Bases: {py:obj}`docutils.parsers.rst.Directive`

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleListDirective
```

```{rubric} Initialization
```

```{autodoc2-docstring} localecmddoc.codeblock.LocalecmdExampleListDirective.__init__
```

````

````{py:function} clean_example_dicts(app: sphinx.application.Sphinx, env: sphinx.environment.BuildEnvironment, docname: str)
:canonical: localecmddoc.codeblock.clean_example_dicts

```{autodoc2-docstring} localecmddoc.codeblock.clean_example_dicts
```
````

````{py:function} process_code_blocks(app: sphinx.application.Sphinx, doctree: docutils.nodes.document, docname: str)
:canonical: localecmddoc.codeblock.process_code_blocks

```{autodoc2-docstring} localecmddoc.codeblock.process_code_blocks
```
````

````{py:function} run_codeblocks(app: sphinx.application.Sphinx, doctree: docutils.nodes.document, docname: str)
:canonical: localecmddoc.codeblock.run_codeblocks

```{autodoc2-docstring} localecmddoc.codeblock.run_codeblocks
```
````

````{py:function} generate_example_list(app: sphinx.application.Sphinx, doctree: docutils.nodes.document, docname: str)
:canonical: localecmddoc.codeblock.generate_example_list

```{autodoc2-docstring} localecmddoc.codeblock.generate_example_list
```
````