pydoctor.sphinx.SphinxInventoryWriter

class documentation

class SphinxInventoryWriter: (source)

Constructor: SphinxInventoryWriter(system_msg, project_name, project_version)

View In Hierarchy

Sphinx inventory handler.

Method __init__ Undocumented
Method generate Generate Sphinx objects inventory version 2 at `basepath`/objects.inv.
Method info Undocumented
Method warning 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 _project_name Undocumented
Instance Variable _project_version Undocumented
Instance Variable _system_msg Undocumented
def __init__(self, system_msg: Callable[..., None], project_name: str, project_version: str): (source)

Undocumented

def generate(self, subjects: Iterable[Documentable], basepath: str | os.PathLike[str]): (source)

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

def info(self, where: str, message: str): (source)

Undocumented

def warning(self, where: str, message: str): (source)

Undocumented

def _generateContent(self, subjects: Iterable[Documentable]) -> bytes: (source)

Write inventory for all `subjects`.

def _generateHeader(self) -> bytes: (source)

Return header for project with name.

def _generateLine(self, obj: Documentable) -> str: (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: -

def _openFileForWriting(self, path: str) -> ContextManager[IO[bytes]]: (source)

Helper for testing.

_project_name = (source)

Undocumented

_project_version = (source)

Undocumented

_system_msg = (source)

Undocumented