feat: Allow custom list of domains for inventories

ssbarnea · web-flow · commit f5ea6fd81f7a · 2023-01-23T23:30:10.000+01:00
Issue mkdocstrings/mkdocstrings#510: mkdocstrings/mkdocstrings#510 PR #49: #49
diff --git a/docs/schema.json b/docs/schema.json
@@ -26,6 +26,14 @@
                   "base_url": {
                     "title": "Base URL used to build references URLs.",
                     "type": "string"
+                  },
+                  "domains": {
+                    "title": "Domains to import from the inventory.",
+                    "description": "If not defined it will only import 'py' domain.",
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
                   }
                 }
               }
@@ -203,4 +211,4 @@
     }
   },
   "additionalProperties": false
-}
+}
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,7 @@ classifiers = [
     "Typing :: Typed",
 ]
 dependencies = [
-    "mkdocstrings>=0.19",
+    "mkdocstrings>=0.20",
     "griffe>=0.24",
 ]
 
diff --git a/src/mkdocstrings_handlers/python/handler.py b/src/mkdocstrings_handlers/python/handler.py
@@ -169,6 +169,7 @@ def load_inventory(
         in_file: BinaryIO,
         url: str,
         base_url: Optional[str] = None,
+        domains: list[str] | None = None,
         **kwargs: Any,
     ) -> Iterator[Tuple[str, str]]:
         """Yield items and their URLs from an inventory file streamed from `in_file`.
@@ -179,15 +180,17 @@ def load_inventory(
             in_file: The binary file-like object to read the inventory from.
             url: The URL that this file is being streamed from (used to guess `base_url`).
             base_url: The URL that this inventory's sub-paths are relative to.
+            domains: A list of domain strings to filter the inventory by, when not passed, "py" will be used.
             **kwargs: Ignore additional arguments passed from the config.
 
         Yields:
             Tuples of (item identifier, item URL).
         """
+        domains = domains or ["py"]
         if base_url is None:
             base_url = posixpath.dirname(url)
 
-        for item in Inventory.parse_sphinx(in_file, domain_filter=("py",)).values():  # noqa: WPS526
+        for item in Inventory.parse_sphinx(in_file, domain_filter=domains).values():  # noqa: WPS526
             yield item.name, posixpath.join(base_url, item.uri)
 
     def collect(self, identifier: str, config: Mapping[str, Any]) -> CollectorItem:  # noqa: D102,WPS231

Original file line number	Diff line number	Diff line change
`@@ -26,6 +26,14 @@`
`26`	`26`	`"base_url": {`
`27`	`27`	`"title": "Base URL used to build references URLs.",`
`28`	`28`	`"type": "string"`
	`29`	`+ },`
	`30`	`+ "domains": {`
	`31`	`+ "title": "Domains to import from the inventory.",`
	`32`	`+ "description": "If not defined it will only import 'py' domain.",`
	`33`	`+ "type": "array",`
	`34`	`+ "items": {`
	`35`	`+ "type": "string"`
	`36`	`+ }`
`29`	`37`	`}`
`30`	`38`	`}`
`31`	`39`	`}`
`@@ -203,4 +211,4 @@`
`203`	`211`	`}`
`204`	`212`	`},`
`205`	`213`	`"additionalProperties": false`
`206`		`-}`
	`214`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@ classifiers = [`
`29`	`29`	`"Typing :: Typed",`
`30`	`30`	`]`
`31`	`31`	`dependencies = [`
`32`		`- "mkdocstrings>=0.19",`
	`32`	`+ "mkdocstrings>=0.20",`
`33`	`33`	`"griffe>=0.24",`
`34`	`34`	`]`
`35`	`35`