DOC001#

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

Bases: Documentation

The doc/source structure exists.

Overview#

check

Return whether the documentation index exists.

Import detail#

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

Method detail#

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

Return whether the documentation index exists.