Add note about checking README in pep8 tests

PyPi now validates that the description used for a package is in valid
RST format. This adds a note to the pep8 style check information for
Python project setup suggesting that checks are run in the pep8 target
to make sure RST validation passes.

Change-Id: Idb2ed741ec8c9b683547e1e7884e2306739ad096
This commit is contained in:
Sean McGinnis 2018-05-29 14:27:13 -05:00
parent 6ef7b74741
commit ccccdd32b4
1 changed files with 14 additions and 0 deletions

View File

@ -113,6 +113,20 @@ Just run::
$ tox -e pep8
.. note::
For projects that publish their deliverables to PyPi, there are some extra
checks that are recommended for the RST formatting of the repo's README
file. In most cases, the repo's README file is used as the package
description on PyPi, and the upload of new packages to PyPi validate that
the description is valid RST.
It is recommended that these projects add the following command to be run
under the pep8 tox target:
python setup.py check --restructuredtext --strict
Run One Test
^^^^^^^^^^^^