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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pybuilder-docstr-coverage-0.1.1.tar.gz.
File metadata
- Download URL: pybuilder-docstr-coverage-0.1.1.tar.gz
- Upload date:
- Size: 2.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
969ead1338b07749f88e60145af66dafaf717fe47285993535e30f83d297aa0d
|
|
| MD5 |
9ce62239b91ae7d72070e12d0142375f
|
|
| BLAKE2b-256 |
8389cb61a2f41496f9f2e5403850eaf40ee266c4944ae5e51c6176e2379f40f8
|
File details
Details for the file pybuilder_docstr_coverage-0.1.1-py3.10.egg.
File metadata
- Download URL: pybuilder_docstr_coverage-0.1.1-py3.10.egg
- Upload date:
- Size: 3.0 kB
- Tags: Egg
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b63bd053d5d710deca7af9cb359f97dd0adbed81f092a540b68182f0fda4d6f2
|
|
| MD5 |
d90065e8652685cbf8f13044166757d9
|
|
| BLAKE2b-256 |
d6d8c3e7456ac11e9f79583e4216afb0fe9171e61795d70cdc338a3ae15480af
|
File details
Details for the file pybuilder_docstr_coverage-0.1.1-py3-none-any.whl.
File metadata
- Download URL: pybuilder_docstr_coverage-0.1.1-py3-none-any.whl
- Upload date:
- Size: 2.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
aa6aee854ed5ba7fb8f27c5d99ab53dc975489b7e83ecef4eb343a11b468dfb0
|
|
| MD5 |
5b1a334ca0d85adac633a33f03c7f875
|
|
| BLAKE2b-256 |
46d68e8bf143a1a4799fb502d92a4a425a4f307637c8d7ec94887e4901bcd35a
|
