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		'warn'
anchors	ValidationLevel | None		'info'
absolute_links	ValidationLevelForAbsolute | None		'info'
unrecognized_links	ValidationLevel | None		'info'

Source code in mkdocs_mknodes/appconfig/validationconfig.py

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

Nav

Bases: BaseModel

Parameters:

Name	Type	Description	Default
omitted_files	ValidationLevel | None		'info'
not_found	ValidationLevel | None		'warn'
absolute_links	ValidationLevel | None		'info'

Source code in mkdocs_mknodes/appconfig/validationconfig.py

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

ValidationConfig

Bases: BaseModel

Parameters:

Name	Type	Description	Default
nav	Nav		Nav(omitted_files='info', not_found='warn', absolute_links='info')
links	Links		Links(not_found='warn', anchors='info', absolute_links='info', unrecognized_links='info')
omitted_files	ValidationLevel		<ValidationLevel.info: 'info'>
not_found	ValidationLevel		<ValidationLevel.warn: 'warn'>
absolute_links	ValidationLevelForAbsolute		<ValidationLevelForAbsolute.info: 'info'>
anchors	ValidationLevel		<ValidationLevel.info: 'info'>
unrecognized_links	ValidationLevel		<ValidationLevel.info: 'info'>

Source code in mkdocs_mknodes/appconfig/validationconfig.py

class ValidationConfig(BaseModel):
    nav: Nav = Field(default_factory=Nav)
    links: Links = Field(default_factory=Links)
    omitted_files: ValidationLevel = ValidationLevel.info
    not_found: ValidationLevel = ValidationLevel.warn
    absolute_links: ValidationLevelForAbsolute = ValidationLevelForAbsolute.info
    anchors: ValidationLevel = ValidationLevel.info
    unrecognized_links: ValidationLevel = ValidationLevel.info