DOC002#

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

Bases: Documentation

The Sphinx config exists.

Overview#

check

Return whether the Sphinx configuration exists.

Import detail#

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

Method detail#

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

Return whether the Sphinx configuration exists.