Skip to main content

PyBuilder plugin that checks documentation coverage using docstr-coverage

Project description

Uses docstr-coverage to check documentation coverage of your project.

You can configure the docstr-coverage package using the following properties:

  • docstr_coverage_fail_under: The minimum coverage percentage that must be achieved. If the coverage is below this value, the build will fail. This will take precedence over the value set in the configuration file.

  • docstr_coverage_config: The path to the configuration file for docstr-coverage. Default: .docstr.yaml

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pybuilder-docstr-coverage-0.1.1.tar.gz (2.2 kB view hashes)

Uploaded Source

Built Distributions

pybuilder_docstr_coverage-0.1.1-py3.10.egg (3.0 kB view hashes)

Uploaded Source

pybuilder_docstr_coverage-0.1.1-py3-none-any.whl (2.7 kB view hashes)

Uploaded Python 3

Supported by

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