class documentation
class SphinxInventoryWriter: (source)
Constructor: SphinxInventoryWriter(logger, project_name, project_version)
Sphinx inventory handler.
Method | __init__ |
Undocumented |
Method | error |
Undocumented |
Method | generate |
Generate Sphinx objects inventory version 2 at `basepath`/objects.inv. |
Method | info |
Undocumented |
Method | _generate |
Write inventory for all `subjects`. |
Method | _generate |
Return header for project with name. |
Method | _generate |
Return inventory line for object. |
Method | _open |
Helper for testing. |
Instance Variable | _logger |
Undocumented |
Instance Variable | _project |
Undocumented |
Instance Variable | _project |
Undocumented |
def __init__(self, logger:
Callable[ ..., None]
, project_name: str
, project_version: str
):
(source)
¶
Undocumented
Return inventory line for object.
name domain_name:type priority URL display_name
Domain name is always: py Priority is always: -1 Display name is always: -