validationconfig

Class info

Classes

Name	Children	Inherits
Links mkdocs_mknodes.appconfig.validationconfig		BaseModel
Nav mkdocs_mknodes.appconfig.validationconfig		BaseModel
ValidationConfig mkdocs_mknodes.appconfig.validationconfig		BaseModel
ValidationLevel mkdocs_mknodes.appconfig.validationconfig		Enum
ValidationLevelForAbsolute mkdocs_mknodes.appconfig.validationconfig		Enum

🛈 DocStrings

Links

Bases: BaseModel

Parameters:

Name	Type	Description	Default
not_found	ValidationLevel | None		<ValidationLevel.warn: 'warn'>
anchors	ValidationLevel | None		<ValidationLevel.info: 'info'>
absolute_links	ValidationLevelForAbsolute | None		<ValidationLevelForAbsolute.info: 'info'>
unrecognized_links	ValidationLevel | None		<ValidationLevel.info: 'info'>

Source code in mkdocs_mknodes/appconfig/validationconfig.py

class Links(BaseModel):
    not_found: ValidationLevel | None = ValidationLevel.warn
    anchors: ValidationLevel | None = ValidationLevel.info
    absolute_links: ValidationLevelForAbsolute | None = ValidationLevelForAbsolute.info
    unrecognized_links: ValidationLevel | None = ValidationLevel.info

Nav

Bases: BaseModel

Parameters:

Name	Type	Description	Default
omitted_files	ValidationLevel | None		<ValidationLevel.info: 'info'>
not_found	ValidationLevel | None		<ValidationLevel.warn: 'warn'>
absolute_links	ValidationLevel | None		<ValidationLevel.info: 'info'>

Source code in mkdocs_mknodes/appconfig/validationconfig.py

class Nav(BaseModel):
    omitted_files: ValidationLevel | None = ValidationLevel.info
    not_found: ValidationLevel | None = ValidationLevel.warn
    absolute_links: ValidationLevel | None = ValidationLevel.info

ValidationConfig

Bases: BaseModel

Parameters:

Name	Type	Description	Default
nav	Nav | None		None
links	Links | None		None
omitted_files	ValidationLevel | None		None
not_found	ValidationLevel | None		None
absolute_links	ValidationLevelForAbsolute | None		None
anchors	ValidationLevel | None		None
unrecognized_links	ValidationLevel | None		None

Source code in mkdocs_mknodes/appconfig/validationconfig.py

class ValidationConfig(BaseModel):
    nav: Nav | None = None
    links: Links | None = None
    omitted_files: ValidationLevel | None = None
    not_found: ValidationLevel | None = None
    absolute_links: ValidationLevelForAbsolute | None = None
    anchors: ValidationLevel | None = None
    unrecognized_links: ValidationLevel | None = None