DOC015#

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

Bases: Documentation

The user-guide page is provided as a root page or section index.

Overview#

check

Recommend either supported user-guide page path.

Import detail#

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

Method detail#

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

Recommend either supported user-guide page path.