pydoctor.sphinx.SphinxInventory

class documentation

class SphinxInventory: (source)

Known subclasses: pydoctor.test.test_sphinx.InvReader

View In Hierarchy

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, project_name=None): (source)
Parameters
logger:Callable[..., None]Undocumented
project_name:Optional[str]Dummy argument to stay compatible with twisted.python._pydoctor.
def error(self, where, message): (source)

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def getLink(self, name): (source)

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

Parameters
name:strUndocumented
Returns
Optional[str]Undocumented
def update(self, cache, url): (source)

Update inventory from URL.

Parameters
cache:CacheTUndocumented
url:strUndocumented
def _getPayload(self, base_url, data): (source)

Parse inventory and return clear text payload without comments.

Parameters
base_url:strUndocumented
data:bytesUndocumented
Returns
strUndocumented
def _parseInventory(self, base_url, payload): (source)

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

Parameters
base_url:strUndocumented
payload:strUndocumented
Returns
Dict[str, Tuple[str, str]]Undocumented
_links: Dict[str, Tuple[str, str]] = (source)

Undocumented

_logger = (source)
overridden in pydoctor.test.test_sphinx.InvReader

Undocumented