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	`_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	`_logger`	Undocumented

def __init__(self, logger: Callable[..., None], project_name: Optional[str] = None): (source) ¶

Parameters
logger:`Callable[..., None]`	Undocumented
project_name:`Optional[str]`	Dummy argument to stay compatible with `twisted.python._pydoctor`.

def error(self, where: str, message: str): (source) ¶

Undocumented

def getLink(self, name: str) -> Optional[str]: (source) ¶

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

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

Update inventory from URL.

def _getPayload(self, base_url: 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