module documentation

The command-line parsing and entry point.
Class ​Custom​Option Undocumented
Function error Undocumented
Function find​Class​From​Dotted​Name Looks up a class by full name. Watch out, prints a message and SystemExits on error!
Function getparser Undocumented
Function main This is the console_scripts entry point for pydoctor CLI.
Function parse​_args Undocumented
Function parse​_path Parse a path value given to an option to a Path object using resolve_path().
Function read​Config​File Undocumented
Function resolve​_path Parse a given path string to a Path object.
Constant BUILDTIME​_FORMAT Undocumented
Constant MAKE​_HTML​_DEFAULT Undocumented
Constant T Undocumented
Function ​_warn​_deprecated​_options Check the CLI options and warn on deprecated options.
def error(msg, *args):

Undocumented

Parameters
msg:strUndocumented
*args:objectUndocumented
Returns
NoReturnUndocumented
def findClassFromDottedName(dottedname, optionname, base_class):
Looks up a class by full name. Watch out, prints a message and SystemExits on error!
Parameters
dottedname:strUndocumented
optionname:strUndocumented
base​_class:Type[T]Undocumented
Returns
Type[T]Undocumented
def getparser():

Undocumented

Returns
OptionParserUndocumented
def main(args=sys.argv[1:]):
This is the console_scripts entry point for pydoctor CLI.
Parameters
args:Sequence[str]Command line arguments to run the CLI.
Returns
intUndocumented
def parse_args(args):

Undocumented

Parameters
args:Sequence[str]Undocumented
Returns
Tuple[Values, List[str]]Undocumented
def parse_path(option, opt, value):
Parse a path value given to an option to a Path object using resolve_path().
Parameters
option:OptionUndocumented
opt:strUndocumented
value:strUndocumented
Returns
PathUndocumented
def readConfigFile(options):

Undocumented

Parameters
options:ValuesUndocumented
def resolve_path(path):

Parse a given path string to a Path object.

The path is converted to an absolute path, as required by System.setSourceHref(). The path does not need to exist.

Parameters
path:strUndocumented
Returns
PathUndocumented
BUILDTIME_FORMAT: str =

Undocumented

Value
'%Y-%m-%d %H:%M:%S'
MAKE_HTML_DEFAULT =

Undocumented

Value
object()
T =

Undocumented

Value
TypeVar('T')
def _warn_deprecated_options(options):
Check the CLI options and warn on deprecated options.
Parameters
options:ValuesUndocumented