fix: Support Griffe loader options, correctly pass them to the loader

Issue-13: #13

Author: pawamoy

mkdocs.yml

@@ -109,6 +109,7 @@ plugins:
       python:
         inventories:
         - https://docs.python.org/3/objects.inv
+        - https://mkdocstrings.github.io/griffe/objects.inv
         paths: [src]
         options:
           backlinks: tree

src/griffe2md/_internal/config.py

@@ -14,6 +14,8 @@
 if TYPE_CHECKING:
     from re import Pattern
 
+    from griffe import DocstringOptions, LoadableExtensionType
+
 _logger = logging.getLogger(__name__)
 
 CONFIG_FILE_PATHS = (
@@ -59,7 +61,7 @@ class ConfigDict(TypedDict):
     annotations_path: Literal["brief", "source", "full"]
     """The verbosity for annotations path: `brief` (recommended), `source` (as written in the source), or `full`."""
 
-    docstring_options: dict
+    docstring_options: DocstringOptions
     """mkdocstring [configuration](https://mkdocstrings.github.io/python/usage/configuration/general/)"""
 
     docstring_section_style: Literal["list", "table"]
@@ -68,6 +70,9 @@ class ConfigDict(TypedDict):
     docstring_style: Literal["google", "numpy", "sphinx", "auto"] | None
     """The style in which docstrings are written: `auto`, `google`, `numpy`, `sphinx`, or `None`."""
 
+    extensions: list[LoadableExtensionType]
+    """A list of Griffe extensions to load."""
+
     filters: list[str] | list[tuple[Pattern[str], bool]]
     """A list of filters.
 
@@ -76,6 +81,9 @@ class ConfigDict(TypedDict):
     to lower members in the hierarchy).
     """
 
+    force_inspection: bool
+    """Force using introspection on modules even if sources are available."""
+
     group_by_category: bool
     """Group the object's children by categories: attributes, classes, functions, and modules."""
 
@@ -125,6 +133,9 @@ class ConfigDict(TypedDict):
     The modules must be listed as an array of strings.
     """
 
+    search_paths: list[str]
+    """A list of paths to search packages into."""
+
     separate_signature: bool
     """Whether to put the whole signature in a code block below the heading.
 
@@ -248,9 +259,12 @@ class ConfigDict(TypedDict):
     "preload_modules": None,
     "load_external_modules": False,
     "allow_inspection": True,
+    "force_inspection": False,
     "summary": True,
     "show_docstring_classes": True,
     "show_docstring_functions": True,
     "show_docstring_modules": True,
+    "extensions": [],
+    "search_paths": [],
 }
 """Default configuration values."""

src/griffe2md/_internal/main.py

@@ -6,14 +6,14 @@
 from typing import IO, TYPE_CHECKING, cast
 
 import mdformat
-from griffe import GriffeLoader, Parser
+from griffe import GriffeLoader, Parser, load_extensions
 from jinja2 import Environment, FileSystemLoader
 
 from griffe2md._internal import rendering
 from griffe2md._internal.config import ConfigDict, default_config
 
 if TYPE_CHECKING:
-    from griffe import Object
+    from griffe import DocstringOptions, Object
 
 
 def _output(text: str, to: IO | str | None = None) -> None:
@@ -122,6 +122,12 @@ def render_object_docs(obj: Object, config: ConfigDict | None = None) -> str:
         obj: The Griffe object to render docs for.
         config: The rendering configuration.
 
+    Warning:
+        When using this function programmatically,
+        options such as `docstring_style` and `docstring_options` must be passed
+        to the Griffe loader so that they are correctly set when loading data.
+        Check [`griffe.GriffeLoader`][] for more information.
+
     Returns:
         Markdown.
     """
@@ -143,7 +149,16 @@ def render_package_docs(package: str, config: ConfigDict | None = None) -> str:
     """
     config = cast("ConfigDict", {**default_config, **(config or {})})
     parser = config["docstring_style"] and Parser(config["docstring_style"])
-    loader = GriffeLoader(docstring_parser=parser)
+    parser_options: DocstringOptions = config["docstring_options"]
+    extensions = load_extensions(*config["extensions"]) if config["extensions"] else None
+    loader = GriffeLoader(
+        extensions=extensions,
+        search_paths=config["search_paths"] + sys.path,
+        docstring_parser=parser,
+        docstring_options=parser_options,
+        allow_inspection=config["allow_inspection"],
+        force_inspection=config["force_inspection"],
+    )
     module = loader.load(package)
     loader.resolve_aliases(external=True)
     return render_object_docs(module, config)  # type: ignore[arg-type]