pydoctor.options

module documentation
(source)

The command-line parsing.

Class Options Container for all possible pydoctor options.
Function get_parser Undocumented
Function parse_args Undocumented
Constant BUILDTIME_FORMAT Undocumented
Constant BUILDTIME_FORMAT_HELP Undocumented
Constant CONFIG_SECTIONS Undocumented
Constant DEFAULT_CONFIG_FILES Undocumented
Constant DEFAULT_SYSTEM Undocumented
Variable PydoctorConfigParser Undocumented
Function _convert_htmlwriter Undocumented
Function _convert_privacy Undocumented
Function _convert_projectbasedirectory Undocumented
Function _convert_sourcepath Undocumented
Function _convert_systemclass Undocumented
Function _convert_templatedir Undocumented
Function _get_viewsource_template Recognize several version control providers based on option --html-viewsource-base.
Function _warn_deprecated_options Check the CLI options and warn on deprecated options.
Constant _RECOGNIZED_SOURCE_HREF Undocumented
def get_parser(): (source)

Undocumented

Returns
ArgumentParserUndocumented
def parse_args(args): (source)

Undocumented

Parameters
args:Sequence[str]Undocumented
Returns
NamespaceUndocumented
BUILDTIME_FORMAT: str = (source)

Undocumented

Value
'%Y-%m-%d %H:%M:%S'
BUILDTIME_FORMAT_HELP: str = (source)

Undocumented

Value
'YYYY-mm-dd HH:MM:SS'
CONFIG_SECTIONS: list[str] = (source)

Undocumented

Value
['tool.pydoctor', 'tool:pydoctor', 'pydoctor']
DEFAULT_CONFIG_FILES: list[str] = (source)

Undocumented

Value
['./pyproject.toml', './setup.cfg', './pydoctor.ini']
DEFAULT_SYSTEM: str = (source)

Undocumented

Value
'pydoctor.model.System'
PydoctorConfigParser = (source)

Undocumented

def _convert_htmlwriter(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
Type[IWriter]Undocumented
def _convert_privacy(l): (source)

Undocumented

Parameters
l:List[str]Undocumented
Returns
List[Tuple[model.PrivacyClass, str]]Undocumented
def _convert_projectbasedirectory(s): (source)

Undocumented

Parameters
s:Optional[str]Undocumented
Returns
Optional[Path]Undocumented
def _convert_sourcepath(l): (source)

Undocumented

Parameters
l:List[str]Undocumented
Returns
List[Path]Undocumented
def _convert_systemclass(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
Type[model.System]Undocumented
def _convert_templatedir(l): (source)

Undocumented

Parameters
l:List[str]Undocumented
Returns
List[Path]Undocumented
def _get_viewsource_template(sourcebase): (source)

Recognize several version control providers based on option --html-viewsource-base.

Parameters
sourcebase:Optional[str]Undocumented
Returns
strUndocumented
def _warn_deprecated_options(options): (source)

Check the CLI options and warn on deprecated options.

Parameters
options:NamespaceUndocumented
_RECOGNIZED_SOURCE_HREF = (source)

Undocumented

Value
{'{mod_source_href}#l{lineno}': re.compile(r'(^https?://sourceforge\.net/)'),
 '{mod_source_href}#lines-{lineno}': re.compile(r'(^https?://bitbucket\.org/)'),
 '{mod_source_href}#L{lineno}': re.compile(r'(.*)?')}