class documentation

class SphinxInventoryWriter:

Known subclasses: pydoctor.test.test_sphinx.InvWriter

View In Hierarchy

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​Content Write inventory for all `subjects`.
Method _generate​Header Return header for project with name.
Method _generate​Line Return inventory line for object.
Method _open​File​For​Writing Helper for testing.
Instance Variable ​_logger Undocumented
Instance Variable ​_project​_name Undocumented
Instance Variable ​_project​_version Undocumented
def __init__(self, logger, project_name, project_version):

Undocumented

Parameters
logger:Callable[..., None]Undocumented
project​_name:strUndocumented
project​_version:strUndocumented
def error(self, where, message):

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def generate(self, subjects, basepath):
Generate Sphinx objects inventory version 2 at `basepath`/objects.inv.
Parameters
subjects:Iterable[Documentable]Undocumented
basepath:strUndocumented
def info(self, where, message):

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def _generateContent(self, subjects):
Write inventory for all `subjects`.
Parameters
subjects:Iterable[Documentable]Undocumented
Returns
bytesUndocumented
def _generateHeader(self):
Return header for project with name.
Returns
bytesUndocumented
def _generateLine(self, obj):

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: -

Parameters
obj:DocumentableUndocumented
Returns
strUndocumented
def _openFileForWriting(self, path):
Helper for testing.
Parameters
path:strUndocumented
Returns
ContextManager[IO[bytes]]Undocumented
_logger =

Undocumented

_project_name =

Undocumented

_project_version =

Undocumented