DOC029#

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

Bases: Documentation

Sphinx AutoAPI or an API reference page is available.

Overview#

check

Find AutoAPI references in the config or accept a manually maintained API page.

Import detail#

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

Method detail#

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

Find AutoAPI references in the config or accept a manually maintained API page.