Enforce Python Docstring Coverage Thresholds with interrogate

Measure Python docstring coverage and fail a docs-quality gate when code drops below an agreed threshold.

Prerequisites

Python, interrogate, Python source tree

Installation

Use the upstream install or setup path that matches your environment:

• $ pip install interrogate
• $ pip install interrogate[png]

Requirements and caveats from upstream:

• Documentation should be as important as code itself. And it should live within code. Python standardized https://www.python.org/dev/peps/pep-0257/_ docstrings, allowing for developers to navigate libraries as simp...
• interrogate supports Python 3.8 and above.
• Try it out on a Python project:

Basic usage or getting-started notes:

• ============

• interrogate is available on PyPI https://pypi.org/project/interrogate/_ and GitHub https://github.com/econchick/interrogate. The recommended installation method is pip https://pip.pypa.io/en/stable/-installing...

• .. code-block:: console

• Source: https://github.com/econchick/interrogate

• Extracted from upstream docs: https://raw.githubusercontent.com/econchick/interrogate/HEAD/README.rst

Documentation

• https://interrogate.readthedocs.io/en/latest/

Source

• Agent Skill Exchange