DOC012#

class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC012#

Bases: Documentation

The index links required documentation pages with cards.

Overview#

check

Require Sphinx Design cards linking to every top-level docs page.

Import detail#

from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC012

Method detail#

static DOC012.check(repository_root: pathlib.Path, readme_file: str | None) → ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#

Require Sphinx Design cards linking to every top-level docs page.