Skip to content
This repository has been archived by the owner on Oct 10, 2024. It is now read-only.

henry0312/pytest-pydocstyle

Folders and files

NameName
Last commit message
Last commit date

Latest commit

85a31af · Oct 9, 2024

History

85 Commits
Oct 9, 2024
Jan 5, 2023
Mar 16, 2022
Mar 23, 2020
Nov 17, 2019
Oct 28, 2022
Apr 3, 2020
Mar 20, 2018
Mar 23, 2020
Oct 9, 2024
Nov 17, 2019
Oct 9, 2024

Repository files navigation

pytest-pydocstyle

PyPI version

pytest plugin to run pydocstyle

Installation

pip install pytest-pydocstyle

Usage

pytest --pydocstyle ...

For detail, please see pytest -h after installation.

Configuration

The behavior can be configured in the same style of pydocstyle.
(cf. Configuration — pytest documentation and Configuration Files — pydocstyle documentation)

For example,

[pydocstyle]
convention = numpy
add-ignore = D400,D403

[tool:pytest]
addopts = --pydocstyle

Licence

The MIT License
Copyright (c) 2019 OMOTO Tsukasa

Acknowledgments