diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2022-01-15 17:16:46 -0500 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2022-01-15 17:16:46 -0500 |
| commit | e52d616a065da649494f37112cadfde0c646a0b9 (patch) | |
| tree | da40e7dc03b021d1480c55c35368a83f97842096 | |
| parent | 0b907fe3fb2eececbec16dccc17aeabb9c64dc15 (diff) | |
| download | python-coveragepy-git-e52d616a065da649494f37112cadfde0c646a0b9.tar.gz | |
build: provide hints about how to fix cog-check quality failures.
| -rw-r--r-- | .github/workflows/kit.yml | 3 | ||||
| -rw-r--r-- | doc/cmd.rst | 4 | ||||
| -rw-r--r-- | doc/dbschema.rst | 4 | ||||
| -rw-r--r-- | tox.ini | 2 |
4 files changed, 13 insertions, 0 deletions
diff --git a/.github/workflows/kit.yml b/.github/workflows/kit.yml index 1948e7ac..99277865 100644 --- a/.github/workflows/kit.yml +++ b/.github/workflows/kit.yml @@ -1,6 +1,9 @@ # Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 # For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt +# This file is meant to be processed with cog. +# Running "make prebuild" will bring it up to date. + # Based on: # https://github.com/joerick/cibuildwheel/blob/master/examples/github-deploy.yml diff --git a/doc/cmd.rst b/doc/cmd.rst index ed86e28a..a26aa8ac 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -1,6 +1,10 @@ .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt +.. This file is meant to be processed with cog to insert the latest command + help into the docs. If it's out of date, the quality checks will fail. + Running "make prebuild" will bring it up to date. + .. [[[cog import contextlib import io diff --git a/doc/dbschema.rst b/doc/dbschema.rst index c6f3395e..9b5ee883 100644 --- a/doc/dbschema.rst +++ b/doc/dbschema.rst @@ -1,6 +1,10 @@ .. Licensed under the Apache License: http://www.apache.org/licenses/LICENSE-2.0 .. For details: https://github.com/nedbat/coveragepy/blob/master/NOTICE.txt +.. This file is meant to be processed with cog to insert the latest database + schema into the docs. If it's out of date, the quality checks will fail. + Running "make prebuild" will bring it up to date. + .. _dbschema: =========================== @@ -60,6 +60,7 @@ deps = whitelist_externals = make commands = + # If this command fails, see the comment at the top of doc/cmd.rst python -m cogapp -cP --check --verbosity=1 doc/*.rst doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst sphinx-build -b html -aEnqW doc doc/_build/html @@ -78,6 +79,7 @@ setenv = commands = python -m tabnanny {env:LINTABLE} python igor.py check_eol + # If this command fails, see the comment at the top of doc/cmd.rst python -m cogapp -cP --check --verbosity=1 doc/*.rst python -m cogapp -cP --check --verbosity=1 .github/workflows/*.yml doc8 -q --ignore-path 'doc/_*' doc CHANGES.rst README.rst |