Class | CustomOption |
Undocumented |
Function | error |
Undocumented |
Function | findClassFromDottedName |
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 | readConfigFile |
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. |
Undocumented
Parameters | |
msg:str | Undocumented |
*args:object | Undocumented |
Returns | |
NoReturn | Undocumented |
Parameters | |
args:Sequence[ | Command line arguments to run the CLI. |
Returns | |
int | Undocumented |
Undocumented
Parameters | |
args:Sequence[ | Undocumented |
Returns | |
Tuple[ | Undocumented |
Path
object using resolve_path()
.Parameters | |
option:Option | Undocumented |
opt:str | Undocumented |
value:str | Undocumented |
Returns | |
Path | Undocumented |
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:str | Undocumented |
Returns | |
Path | Undocumented |