2025 Python Packaging Survey is now live!  Take the survey now

pytest plugin to run pydocstyle

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for henry0312 from gravatar.com henry0312

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Tsukasa OMOTO
  • Requires: Python ~=3.5
Classifiers
Report project as malware

Project description

pytest-docstyle

PyPI version

pytest plugin to run pydocstyle

Installation

pip install pytest-docstyle

Usage

pytest --docstyle ...

For detail, please see pytest -h after installation.

Configuration

You can configure options of pydocstyle with setup.cfg (or pytest.ini).
(cf. Configuration — pytest documentation)

For example,

[tool:pytest]
docstyle_convention = numpy
docstyle_add_ignore = D400 D403

Licence

The MIT License
Copyright (c) 2017 Tsukasa OMOTO

Acknowledgments

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page