pydocspec.converter._Converter

class documentation

class _Converter: (source)

View In Hierarchy

Converts docspec objects to their pydocspec augmented version.

Method convert_docspec_modules Convert docspec.Module`s to the `TreeRoot instance.
Instance Variable root Undocumented
Method _convert_docspec_module Undocumented
def convert_docspec_modules(self, modules): (source)

Convert docspec.Module`s to the `TreeRoot instance.

Parameters
modules:Iterable[docspec.Module]Undocumented
root: pydocspec.TreeRoot = (source)

Undocumented

def _convert_docspec_module(self, mod): (source)

Undocumented

Parameters
mod:docspec.ModuleUndocumented