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