pydoctor.sphinx.SphinxInventory

class documentation

class SphinxInventory:

Known subclasses: pydoctor.test.test_sphinx.InvReader

View In Hierarchy

Sphinx inventory handler.
Method __init__
Method error Undocumented
Method get​Link Return link for `name` or None if no link is found.
Method update Update inventory from URL.
Method _get​Payload Parse inventory and return clear text payload without comments.
Method _parse​Inventory 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):
Parameters
logger:Callable[..., None]Undocumented
project​_name:Optional[str]Dummy argument to stay compatible with twisted.python._pydoctor.
def error(self, where, message):

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def getLink(self, name):
Return link for `name` or None if no link is found.
Parameters
name:strUndocumented
Returns
Optional[str]Undocumented
def update(self, cache, url):
Update inventory from URL.
Parameters
cache:CacheTUndocumented
url:strUndocumented
def _getPayload(self, base_url, data):
Parse inventory and return clear text payload without comments.
Parameters
base​_url:strUndocumented
data:bytesUndocumented
Returns
strUndocumented
def _parseInventory(self, base_url, payload):
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]] =

Undocumented

_logger =
overridden in pydoctor.test.test_sphinx.InvReader

Undocumented