pydoctor.sphinx.SphinxInventory

class documentation

class SphinxInventory: (source)

Sphinx inventory handler.

Method	`__init__`	No summary
Method	`error`	Undocumented
Method	`getLink`	Return link for `name` or None if no link is found.
Method	`update`	Update inventory from URL.
Method	`update_file`	Update inventory from local path. If base_url is supplied, the links are made relative to the supplied base url.
Method	`warning`	Undocumented
Method	`_exception`	Undocumented
Method	`_getPayload`	Parse inventory and return clear text payload without comments.
Method	`_parseInventory`	Parse clear text payload and return a dict with module to link mapping.
Instance Variable	`_links`	Undocumented
Instance Variable	`_system_msg`	Undocumented
Instance Variable	`_verbosity`	Undocumented

def __init__(self, system_msg: Callable[..., None], project_name: str | None = None, *, verbosity: int = 0): (source) ¶

def error(self, message: str) -> NoReturn: (source) ¶

Undocumented

def getLink(self, name: str) -> str | None: (source) ¶

Return link for `name` or None if no link is found.

def update(self, cache: CacheT, url: str, base_url: str | None): (source) ¶

Update inventory from URL.

Raises
`SphinxInventoryError`	If the process fails

def update_file(self, path: str, base_url: str | None): (source) ¶

Update inventory from local path. If base_url is supplied, the links are made relative to the supplied base url.

Raises
`SphinxInventoryError`	If the process fails

def warning(self, message: str): (source) ¶

Undocumented

def _exception(self, msg: str, err: Exception) -> NoReturn: (source) ¶

Undocumented

def _getPayload(self, payload_source: str, data: bytes) -> str: (source) ¶

Parse inventory and return clear text payload without comments.

def _parseInventory(self, base_url: str, payload: str) -> dict[str, tuple[str, str]]: (source) ¶

Parse clear text payload and return a dict with module to link mapping.

_links: dict[str, tuple[str, str]] = (source) ¶

Undocumented

Undocumented

Undocumented