DOC005#
- class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC005#
Bases:
DocumentationThe index page has a getting started section.
Overview#
Return whether the documentation index has a getting-started section. |
Import detail#
from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC005
Method detail#
- static DOC005.check(repository_root: pathlib.Path, readme_file: str | None) ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#
Return whether the documentation index has a getting-started section.