pydoctor.sphinx.SphinxInventoryWriter

class documentation

class SphinxInventoryWriter: (source)

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 _generateContent Write inventory for all `subjects`.
Method _generateHeader Return header for project with name.
Method _generateLine Return inventory line for object.
Method _openFileForWriting 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): (source)

Undocumented

Parameters
logger:Callable[..., None]Undocumented
project_name:strUndocumented
project_version:strUndocumented
def error(self, where, message): (source)

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def generate(self, subjects, basepath): (source)

Generate Sphinx objects inventory version 2 at `basepath`/objects.inv.

Parameters
subjects:Iterable[Documentable]Undocumented
basepath:strUndocumented
def info(self, where, message): (source)

Undocumented

Parameters
where:strUndocumented
message:strUndocumented
def _generateContent(self, subjects): (source)

Write inventory for all `subjects`.

Parameters
subjects:Iterable[Documentable]Undocumented
Returns
bytesUndocumented
def _generateHeader(self): (source)

Return header for project with name.

Returns
bytesUndocumented
def _generateLine(self, obj): (source)

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): (source)

Helper for testing.

Parameters
path:strUndocumented
Returns
ContextManager[IO[bytes]]Undocumented
_logger = (source)
overridden in pydoctor.test.test_sphinx.InvWriter

Undocumented

_project_name = (source)

Undocumented

_project_version = (source)

Undocumented