DOC004#
- class src.ansys.pre_commit_hooks.quality_rules.documentation.DOC004#
Bases:
DocumentationIntersphinx is enabled for cross-project documentation references.
Overview#
Recommend intersphinx for linking to external project documentation. |
Import detail#
from src.ansys.pre_commit_hooks.quality_rules.documentation import DOC004
Method detail#
- static DOC004.check(repository_root: pathlib.Path, readme_file: str | None) ansys.pre_commit_hooks.quality_rules.common.RuleCheckResult#
Recommend intersphinx for linking to external project documentation.