Metadata-Version: 2.1
Name: griffe-autodocstringstyle
Version: 0.1.0
Summary: Set docstring style to 'auto' for external packages.
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
License: ISC
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
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 :: 3.13
Classifier: Topic :: Documentation
Classifier: Topic :: Software Development
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Project-URL: Homepage, https://mkdocstrings.github.io/griffe-autodocstringstyle
Project-URL: Documentation, https://mkdocstrings.github.io/griffe-autodocstringstyle
Project-URL: Changelog, https://mkdocstrings.github.io/griffe-autodocstringstyle/changelog
Project-URL: Repository, https://github.com/mkdocstrings/griffe-autodocstringstyle
Project-URL: Issues, https://github.com/mkdocstrings/griffe-autodocstringstyle/issues
Project-URL: Discussions, https://github.com/mkdocstrings/griffe-autodocstringstyle/discussions
Project-URL: Gitter, https://gitter.im/mkdocstrings/griffe-autodocstringstyle
Project-URL: Funding, https://github.com/sponsors/pawamoy
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# griffe-autodocstringstyle

[![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://mkdocstrings.github.io/griffe-autodocstringstyle/)
[![gitpod](https://img.shields.io/badge/gitpod-workspace-708FCC.svg?style=flat)](https://gitpod.io/#https://github.com/mkdocstrings/griffe-autodocstringstyle)
[![gitter](https://badges.gitter.im/join%20chat.svg)](https://app.gitter.im/#/room/#griffe-autodocstringstyle:gitter.im)

Set docstring style to 'auto' for external packages.

## Installation

This project is available to sponsors only, through my Insiders program.
See Insiders [explanation](https://mkdocstrings.github.io/griffe-autodocstringstyle/insiders/)
and [installation instructions](https://mkdocstrings.github.io/griffe-autodocstringstyle/insiders/installation/).

## Usage

[Enable(https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions)] the `griffe_autodocstringstyle` extension. Now all packages loaded from a virtual environment will have their docstrings parsed with the `auto` style (automatically guessing the docstring style).

Use the `exclude` option to pass package names that shouldn't be considered. This can be useful if you must first install your sources as a package before loading/documenting them (meaning they end up in the virtual environment too).

With MkDocs:

```yaml
plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_autodocstringstyle:
              # only useful if your sources can't be found
              # in the current working directory 
              exclude:
              - my_package
```
