pydoctor.options.Options

class documentation

class Options: (source)

Constructors: Options.defaults(), Options.from_args(args), Options.from_namespace(args), Options(sourcepath, systemclass, projectname, projectversion, ...)

View In Hierarchy

Container for all possible pydoctor options.

See pydoctor --help for more informations.

Class Method defaults Undocumented
Class Method from_args Undocumented
Class Method from_namespace Undocumented
Method __attrs_post_init__ Undocumented
Method __init__ attrs generated method
Constant HTML_SOURCE_TEMPLATE_DEFAULT Undocumented
Constant MAKE_HTML_DEFAULT Undocumented
Instance Variable buildtime Undocumented
Instance Variable clear_intersphinx_cache Undocumented
Instance Variable cls_member_order Undocumented
Instance Variable docformat Undocumented
Instance Variable enable_intersphinx_cache Undocumented
Instance Variable htmlbaseurl Undocumented
Instance Variable htmloutput Undocumented
Instance Variable htmlsourcebase Undocumented
Instance Variable htmlsourcetemplate Undocumented
Instance Variable htmlsubjects Undocumented
Instance Variable htmlsummarypages Undocumented
Instance Variable htmlwriter Undocumented
Instance Variable intersphinx Undocumented
Instance Variable intersphinx_cache_max_age Undocumented
Instance Variable intersphinx_cache_path Undocumented
Instance Variable intersphinx_file Undocumented
Instance Variable introspect_c_modules Undocumented
Instance Variable makehtml Undocumented
Instance Variable makeintersphinx Undocumented
Instance Variable mod_member_order Undocumented
Instance Variable nosidebar Undocumented
Instance Variable pdb Undocumented
Instance Variable prependedpackage Undocumented
Instance Variable privacy Undocumented
Instance Variable processtypes Undocumented
Instance Variable projectbasedirectory Undocumented
Instance Variable projectname Undocumented
Instance Variable projecturl Undocumented
Instance Variable projectversion Undocumented
Instance Variable pyvalreprlinelen Undocumented
Instance Variable pyvalreprmaxlines Undocumented
Instance Variable quietness Undocumented
Instance Variable sidebarexpanddepth Undocumented
Instance Variable sidebartocdepth Undocumented
Instance Variable sourcepath Undocumented
Instance Variable systemclass Undocumented
Instance Variable templatedir Undocumented
Instance Variable testing Undocumented
Instance Variable theme Undocumented
Instance Variable use_hardlinks Undocumented
Instance Variable verbosity Undocumented
Instance Variable warnings_as_errors Undocumented
def defaults(cls) -> Options: (source)

Undocumented

def from_args(cls, args: Sequence[str]) -> Options: (source)

Undocumented

def from_namespace(cls, args: Namespace) -> Options: (source)

Undocumented

def __attrs_post_init__(self): (source)

Undocumented

def __init__(self, sourcepath: list[str], systemclass: str, projectname: str | None, projectversion: str, projecturl: str | None, projectbasedirectory: str | None, testing: bool, pdb: bool, makehtml: bool, makeintersphinx: bool, prependedpackage: str | None, docformat: str, theme: str, processtypes: bool, templatedir: list[str], privacy: list[str], htmlsubjects: list[str] | None, htmlsummarypages: bool, htmloutput: str, htmlwriter: str, htmlsourcebase: str | None, htmlsourcetemplate: str, htmlbaseurl: str | None, buildtime: str | None, warnings_as_errors: bool, verbosity: int, quietness: int, introspect_c_modules: bool, intersphinx: list[str], enable_intersphinx_cache: bool, intersphinx_cache_path: str, clear_intersphinx_cache: bool, intersphinx_cache_max_age: str, intersphinx_file: list[str], pyvalreprlinelen: int, pyvalreprmaxlines: int, sidebarexpanddepth: int, sidebartocdepth: int, nosidebar: int, cls_member_order: Literal['alphabetical', 'source'], mod_member_order: Literal['alphabetical', 'source'], use_hardlinks: bool): (source)

attrs generated method

Parameters
sourcepath:list[str]attr.ib(converter=_convert_sourcepath)
systemclass:strattr.ib(converter=_convert_systemclass)
projectname:str | Noneattr.ib()
projectversion:strattr.ib()
projecturl:str | Noneattr.ib()
projectbasedirectory:str | Noneattr.ib(converter=_convert_projectbasedirectory)
testing:boolattr.ib()
pdb:boolattr.ib()
makehtml:boolattr.ib()
makeintersphinx:boolattr.ib()
prependedpackage:str | Noneattr.ib()
docformat:strattr.ib()
theme:strattr.ib()
processtypes:boolattr.ib()
templatedir:list[str]attr.ib(converter=_convert_templatedir)
privacy:list[str]attr.ib(converter=_convert_privacy)
htmlsubjects:list[str] | Noneattr.ib()
htmlsummarypages:boolattr.ib()
htmloutput:strattr.ib()
htmlwriter:strattr.ib(converter=_convert_htmlwriter)
htmlsourcebase:str | Noneattr.ib()
htmlsourcetemplate:strattr.ib()
htmlbaseurl:str | Noneattr.ib(converter=_convert_htmlbaseurl)
buildtime:str | Noneattr.ib()
warnings_as_errors:boolattr.ib()
verbosity:intattr.ib()
quietness:intattr.ib()
introspect_c_modules:boolattr.ib()
intersphinx:list[str]attr.ib()
enable_intersphinx_cache:boolattr.ib()
intersphinx_cache_path:strattr.ib()
clear_intersphinx_cache:boolattr.ib()
intersphinx_cache_max_age:strattr.ib()
intersphinx_file:list[str]attr.ib(converter=_convert_intersphinx_file)
pyvalreprlinelen:intattr.ib()
pyvalreprmaxlines:intattr.ib()
sidebarexpanddepth:intattr.ib()
sidebartocdepth:intattr.ib()
nosidebar:intattr.ib()
cls_member_order:Literal['alphabetical', 'source']attr.ib()
mod_member_order:Literal['alphabetical', 'source']attr.ib()
use_hardlinks:boolattr.ib()
HTML_SOURCE_TEMPLATE_DEFAULT = (source)

Undocumented

Value
object()
MAKE_HTML_DEFAULT = (source)

Undocumented

Value
object()
buildtime: str | None = (source)

Undocumented

clear_intersphinx_cache: bool = (source)

Undocumented

cls_member_order: Literal['alphabetical', 'source'] = (source)

Undocumented

docformat: str = (source)

Undocumented

enable_intersphinx_cache: bool = (source)

Undocumented

htmlbaseurl: str | None = (source)

Undocumented

htmloutput: str = (source)

Undocumented

htmlsourcebase: str | None = (source)

Undocumented

htmlsourcetemplate: str = (source)

Undocumented

htmlsubjects: list[str] | None = (source)

Undocumented

htmlsummarypages: bool = (source)

Undocumented

htmlwriter: type[IWriter] = (source)

Undocumented

intersphinx: list[str] = (source)

Undocumented

intersphinx_cache_max_age: str = (source)

Undocumented

intersphinx_cache_path: str = (source)

Undocumented

intersphinx_file: list[IntersphinxFile] = (source)

Undocumented

introspect_c_modules: bool = (source)

Undocumented

makehtml: bool = (source)

Undocumented

makeintersphinx: bool = (source)

Undocumented

mod_member_order: Literal['alphabetical', 'source'] = (source)

Undocumented

nosidebar: int = (source)

Undocumented

pdb: bool = (source)

Undocumented

prependedpackage: str | None = (source)

Undocumented

privacy: list[tuple[model.PrivacyClass, str]] = (source)

Undocumented

processtypes: bool = (source)

Undocumented

projectbasedirectory: Path = (source)

Undocumented

projectname: str | None = (source)

Undocumented

projecturl: str | None = (source)

Undocumented

projectversion: str = (source)

Undocumented

pyvalreprlinelen: int = (source)

Undocumented

pyvalreprmaxlines: int = (source)

Undocumented

quietness: int = (source)

Undocumented

sidebarexpanddepth: int = (source)

Undocumented

sidebartocdepth: int = (source)

Undocumented

sourcepath: list[Path] = (source)

Undocumented

systemclass: type[model.System] = (source)

Undocumented

templatedir: list[Path] = (source)

Undocumented

testing: bool = (source)

Undocumented

theme: str = (source)

Undocumented

use_hardlinks: bool = (source)

Undocumented

verbosity: int = (source)

Undocumented

warnings_as_errors: bool = (source)

Undocumented