Oven logo

Oven

Published

pytest plugin to run pydocstyle

pip install pytest-pydocstyle

Package Downloads

Weekly DownloadsMonthly Downloads

Project URLs

Requires Python

~=3.7

Dependencies

    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