feat: Implement no-op extension

Author: pawamoy

README.md

@@ -11,3 +11,25 @@ Set docstring style to 'auto' for external packages.
 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
+```

src/griffe_autodocstringstyle/__init__.py

@@ -5,4 +5,6 @@
 
 from __future__ import annotations
 
-__all__: list[str] = []
+from griffe_autodocstringstyle._internals.extension import AutoDocstringStyleExtension
+
+__all__: list[str] = ["AutoDocstringStyleExtension"]

src/griffe_autodocstringstyle/_internals/__init__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+import griffe
+
+
+class AutoDocstringStyleExtension(griffe.Extension):
+    """Set `auto` docstring style on external packages."""

src/griffe_autodocstringstyle/_internals/extension.py

@@ -0,0 +1,9 @@
+"""Test extension."""
+
+from __future__ import annotations
+
+
+def test_noop() -> None:
+    """Dummy test."""
+    assert True
+