Module

health.validators.rendering

Rendering validator - checks output HTML quality.

Validates:

  • HTML structure is valid
  • No unrendered Jinja2 variables (outside code blocks)
  • Template functions are available
  • SEO metadata present
View source
1 Class

Classes

RenderingValidator
Validates HTML rendering quality. Checks: - Basic HTML structure (<html>, <head>, <body>) - No unr…
6

Validates HTML rendering quality.

Checks:

  • Basic HTML structure (<html>, <head>, <body>)
  • No unrendered Jinja2 variables in output
  • Template functions registered and working
  • Basic SEO metadata present
Inherits from BaseValidator

Methods 1

validate
Run rendering validation checks.
2 list[CheckResult] 
def validate(self, site: Site, build_context: BuildContext | Any | None = None) -> list[CheckResult]

Run rendering validation checks.

Parameters 2
site Site
build_context BuildContext | Any | None
Returns

list[CheckResult]

Internal Methods 5
_check_html_structure
Check basic HTML structure in output pages.
1 list[CheckResult] 
def _check_html_structure(self, site: Site) -> list[CheckResult]

Check basic HTML structure in output pages.

Parameters 1
site Site
Returns

list[CheckResult]

_check_unrendered_jinja2
Check for unrendered Jinja2 syntax in output.
1 list[CheckResult] 
def _check_unrendered_jinja2(self, site: Site) -> list[CheckResult]

Check for unrendered Jinja2 syntax in output.

Parameters 1
site Site
Returns

list[CheckResult]

_detect_unrendered_jinja2
Detect if HTML has unrendered Jinja2 syntax (not in code blocks). Distinguishe…
1 bool 
def _detect_unrendered_jinja2(self, html_content: str) -> bool

Detect if HTML has unrendered Jinja2 syntax (not in code blocks).

Distinguishes between:

  • Actual unrendered templates (bad)
  • Documented/escaped syntax in code blocks (ok)
Parameters 1
html_content str

HTML content to check
Returns

bool —

True if unrendered Jinja2 found (not in code blocks)

_check_template_functions
Check that template functions are registered.
1 list[CheckResult] 
def _check_template_functions(self, site: Site) -> list[CheckResult]

Check that template functions are registered.

Parameters 1
site Site
Returns

list[CheckResult]

_check_seo_metadata
Check for basic SEO metadata in pages.
1 list[CheckResult] 
def _check_seo_metadata(self, site: Site) -> list[CheckResult]

Check for basic SEO metadata in pages.

Parameters 1
site Site
Returns

list[CheckResult]