​​interrogate checks your code base for missing docstrings.

Documentation should be as important as code itself. And it should live within code. #python standardized docstrings, allowing for developers to navigate libraries as simply as calling help() on objects, and with powerful tools like Sphinx, pydoc, and Docutils to automatically generate HTML, LaTeX, PDFs, etc.

interrogate will tell you which methods, functions, classes, and modules have docstrings, and which do not. Use interrogate to:

- Get an understanding of how well your code is documented;
- Add it to CI/CD checks to enforce documentation on newly-added code;
- Assess a new code base for (one aspect of) code quality and maintainability.

Let’s get started!

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

Personal opinion: I really like the incremental addoption feature.

#docops