Metadata-Version: 2.4
Name: mkdocstrings-extensions-simple-config-builder
Version: 0.2.0
Project-URL: Documentation, https://github.com/jogehl/mkdocstrings-extensions-simple-config-builder#readme
Project-URL: Issues, https://github.com/jogehl/mkdocstrings-extensions-simple-config-builder/issues
Project-URL: Source, https://github.com/jogehln/mkdocstrings-extensions-simple-config-builder
Author-email: jogehl <joshuagehlen@hotmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.11
Requires-Dist: griffe
Description-Content-Type: text/markdown

# mkdocstrings_extensions_simple_config_builder

[![PyPI - Version](https://img.shields.io/pypi/v/mkdocstrings-extensions-simple-config-builder.svg)](https://pypi.org/project/mkdocstrings-extensions-simple-config-builder)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mkdocstrings-extensions-simple-config-builder.svg)](https://pypi.org/project/mkdocstrings-extensions-simple-config-builder)

-----

## Table of Contents

- [Installation](#installation)
- [License](#license)

## Installation

```console
pip install mkdocstrings-extensions-simple-config-builder
```

## How to use

You can use this extension as a extension for the mkdocs python handler
to get extra information for the @configclass decorated classes.
    
```yaml
- mkdocstrings:
    handlers:
        python:
            options:
                extensions:
                    - mkdocstrings_extensions_simple_config_builder
```

## License

`mkdocstrings-extensions-simple-config-builder` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
