DOC017#

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

Bases: Documentation

The examples page is provided as a root page or section index.

Overview#

check

Recommend either supported examples page path.

Import detail#

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

Method detail#

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

Recommend either supported examples page path.