feat: Implement no-op extension

Author: pawamoy

README.md

@@ -11,3 +11,24 @@ Mark wildcard imported objects as public.
 This project is available to sponsors only, through my Insiders program.
 See Insiders [explanation](https://mkdocstrings.github.io/griffe-public-wildcard-imports/insiders/)
 and [installation instructions](https://mkdocstrings.github.io/griffe-public-wildcard-imports/insiders/installation/).
+
+## Usage
+
+[Enable](https://mkdocstrings.github.io/griffe/guide/users/extending/#using-extensions) the `griffe_public_wildcard_imports` extension. Now all objects imported through wildcard imports will be considered public, as per the convention.
+
+```python
+# All imported objects are marked as public.
+from somewhere import *
+```
+
+With MkDocs:
+
+```yaml
+plugins:
+- mkdocstrings:
+    handlers:
+      python:
+        options:
+          extensions:
+          - griffe_public_wildcard_imports
+```

mkdocs.yml

@@ -132,6 +132,7 @@ plugins:
           show_root_heading: true
           show_root_full_path: false
           show_signature_annotations: true
+          show_source: false
           show_symbol_type_heading: true
           show_symbol_type_toc: true
           signature_crossrefs: true

pyproject.toml

@@ -28,7 +28,9 @@ classifiers = [
     "Topic :: Utilities",
     "Typing :: Typed",
 ]
-dependencies = []
+dependencies = [
+    "griffe>=0.49",
+]
 
 [project.urls]
 Homepage = "https://mkdocstrings.github.io/griffe-public-wildcard-imports"

src/griffe_public_wildcard_imports/__init__.py

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

src/griffe_public_wildcard_imports/_internals/__init__.py

@@ -0,0 +1,5 @@
+import griffe
+
+
+class PublicWildcardImportsExtension(griffe.Extension):
+    """Mark wildcard imported objects as public."""

src/griffe_public_wildcard_imports/_internals/extension.py

@@ -0,0 +1,6 @@
+"""Test extension."""
+
+
+def test_extension() -> None:
+    """Dummy test."""
+    assert True