DOC014#

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

Bases: Documentation

The getting-started page is provided as a root page or section index.

Overview#

check

Recommend either supported getting-started page path.

Import detail#

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

Method detail#

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

Recommend either supported getting-started page path.