# {py:mod}`quirl.components.documentor`

```{py:module} quirl.components.documentor
```

```{autodocx-docstring} quirl.components.documentor
:allowtitles:
```

## Module Contents

### Classes

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

* - {py:obj}`Documentor <quirl.components.documentor.Documentor>`
  - ```{autodocx-docstring} quirl.components.documentor.Documentor
    :summary:
    ```
````

### Data

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

* - {py:obj}`TYPE_ANNOTATION_PATTERN <quirl.components.documentor.TYPE_ANNOTATION_PATTERN>`
  - ```{autodocx-docstring} quirl.components.documentor.TYPE_ANNOTATION_PATTERN
    :summary:
    ```
````

### API

`````{py:class} Documentor(element: typing.Optional[str] = None, properties: typing.Optional[typing.Dict[str, str]] = None, props: typing.Optional[typing.Dict[str, str]] = None, style: typing.Optional[typing.Dict[str, str]] = None, inner_html: typing.Optional[typing.Union[str, str, float]] = None, children: typing.Optional[typing.List[duck.html.components.HtmlComponent]] = None, **kwargs)
:canonical: quirl.components.documentor.Documentor

Bases: {py:obj}`duck.html.components.container.Container`

```{autodocx-docstring} quirl.components.documentor.Documentor
```

```{rubric} Initialization
```

```{autodocx-docstring} quirl.components.documentor.Documentor.__init__
```

````{py:method} build_description() -> duck.html.components.paragraph.Paragraph
:canonical: quirl.components.documentor.Documentor.build_description

```{autodocx-docstring} quirl.components.documentor.Documentor.build_description
```

````

````{py:method} build_header() -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_header

```{autodocx-docstring} quirl.components.documentor.Documentor.build_header
```

````

````{py:method} build_no_preview_placeholder() -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_no_preview_placeholder

```{autodocx-docstring} quirl.components.documentor.Documentor.build_no_preview_placeholder
```

````

````{py:method} build_preview_section()
:canonical: quirl.components.documentor.Documentor.build_preview_section

```{autodocx-docstring} quirl.components.documentor.Documentor.build_preview_section
```

````

````{py:method} build_prop_group(label: str, props: list, badge_variant: str) -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_prop_group

```{autodocx-docstring} quirl.components.documentor.Documentor.build_prop_group
```

````

````{py:method} build_prop_row(prop_text: str) -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_prop_row

```{autodocx-docstring} quirl.components.documentor.Documentor.build_prop_row
```

````

````{py:method} build_props_section() -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_props_section

```{autodocx-docstring} quirl.components.documentor.Documentor.build_props_section
```

````

````{py:method} build_usage_section() -> duck.html.components.container.Container
:canonical: quirl.components.documentor.Documentor.build_usage_section

```{autodocx-docstring} quirl.components.documentor.Documentor.build_usage_section
```

````

````{py:attribute} docs_no_preview_reason
:canonical: quirl.components.documentor.Documentor.docs_no_preview_reason
:value: >
   "Documentor requires a component_cls to document and isn't meant to preview itself."

```{autodocx-docstring} quirl.components.documentor.Documentor.docs_no_preview_reason
```

````

````{py:attribute} docs_preview_kwargs
:canonical: quirl.components.documentor.Documentor.docs_preview_kwargs
:value: >
   None

```{autodocx-docstring} quirl.components.documentor.Documentor.docs_preview_kwargs
```

````

````{py:method} extract_docstring_usage() -> str
:canonical: quirl.components.documentor.Documentor.extract_docstring_usage

```{autodocx-docstring} quirl.components.documentor.Documentor.extract_docstring_usage
```

````

````{py:method} format_usage_code(kwargs: dict) -> str
:canonical: quirl.components.documentor.Documentor.format_usage_code

```{autodocx-docstring} quirl.components.documentor.Documentor.format_usage_code
```

````

````{py:method} on_create()
:canonical: quirl.components.documentor.Documentor.on_create

```{autodocx-docstring} quirl.components.documentor.Documentor.on_create
```

````

`````

````{py:data} TYPE_ANNOTATION_PATTERN
:canonical: quirl.components.documentor.TYPE_ANNOTATION_PATTERN
:value: >
   'compile(...)'

```{autodocx-docstring} quirl.components.documentor.TYPE_ANNOTATION_PATTERN
```

````