inventory ¤
Module responsible for the objects inventory.
Classes:
-
Inventory
–Inventory of collected and rendered objects.
-
InventoryItem
–Inventory item.
Inventory ¤
Inventory(
items: list[InventoryItem] | None = None,
project: str = "project",
version: str = "0.0.0",
)
Bases: dict
Inventory of collected and rendered objects.
Parameters:
-
items
(list[InventoryItem] | None
, default:None
) –A list of items.
-
project
(str
, default:'project'
) –The project name.
-
version
(str
, default:'0.0.0'
) –The project version.
Methods:
-
format_sphinx
–Format this inventory as a Sphinx
objects.inv
file. -
parse_sphinx
–Parse a Sphinx v2 inventory file and return an
Inventory
from it. -
register
–Create and register an item.
Source code in src/mkdocstrings/inventory.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
|
format_sphinx ¤
format_sphinx() -> bytes
Format this inventory as a Sphinx objects.inv
file.
Returns:
-
bytes
–The inventory as bytes.
Source code in src/mkdocstrings/inventory.py
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
|
parse_sphinx classmethod
¤
parse_sphinx(
in_file: BinaryIO,
*,
domain_filter: Collection[str] = ()
) -> Inventory
Parse a Sphinx v2 inventory file and return an Inventory
from it.
Parameters:
-
in_file
(BinaryIO
) –The binary file-like object to read from.
-
domain_filter
(Collection[str]
, default:()
) –A collection of domain values to allow (and filter out all other ones).
Returns:
-
Inventory
–An inventory containing the collected items.
Source code in src/mkdocstrings/inventory.py
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
|
register ¤
register(
name: str,
domain: str,
role: str,
uri: str,
priority: int = 1,
dispname: str | None = None,
) -> None
Create and register an item.
Parameters:
-
name
(str
) –The item name.
-
domain
(str
) –The item domain, like 'python' or 'crystal'.
-
role
(str
) –The item role, like 'class' or 'method'.
-
uri
(str
) –The item URI.
-
priority
(int
, default:1
) –The item priority. Only used internally by mkdocstrings and Sphinx.
-
dispname
(str | None
, default:None
) –The item display name.
Source code in src/mkdocstrings/inventory.py
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
|
InventoryItem ¤
InventoryItem(
name: str,
domain: str,
role: str,
uri: str,
priority: int = 1,
dispname: str | None = None,
)
Inventory item.
Parameters:
-
name
(str
) –The item name.
-
domain
(str
) –The item domain, like 'python' or 'crystal'.
-
role
(str
) –The item role, like 'class' or 'method'.
-
uri
(str
) –The item URI.
-
priority
(int
, default:1
) –The item priority. Only used internally by mkdocstrings and Sphinx.
-
dispname
(str | None
, default:None
) –The item display name.
Methods:
-
format_sphinx
–Format this item as a Sphinx inventory line.
-
parse_sphinx
–Parse a line from a Sphinx v2 inventory file and return an
InventoryItem
from it.
Source code in src/mkdocstrings/inventory.py
17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 |
|
format_sphinx ¤
format_sphinx() -> str
Format this item as a Sphinx inventory line.
Returns:
-
str
–A line formatted for an
objects.inv
file.
Source code in src/mkdocstrings/inventory.py
43 44 45 46 47 48 49 50 51 52 53 54 55 |
|
parse_sphinx classmethod
¤
parse_sphinx(line: str) -> InventoryItem
Parse a line from a Sphinx v2 inventory file and return an InventoryItem
from it.
Source code in src/mkdocstrings/inventory.py
59 60 61 62 63 64 65 66 67 68 69 70 |
|