mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-06 04:56:54 +00:00
Add docs
This commit is contained in:
parent
50e3ce9c78
commit
257eae684e
12 changed files with 691 additions and 1 deletions
21
docs/setuptools.rst
Normal file
21
docs/setuptools.rst
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
setuptools integration
|
||||
======================
|
||||
|
||||
If setuptools is available, Flake8 provides a command that checks the
|
||||
Python files declared by your project. To use it, add flake8 to your
|
||||
setup_requires::
|
||||
|
||||
setup(
|
||||
name="project",
|
||||
packages=["project"],
|
||||
|
||||
setup_requires=[
|
||||
"flake8"
|
||||
]
|
||||
)
|
||||
|
||||
Running ``python setup.py flake8`` on the command line will check the
|
||||
files listed in your ``py_modules`` and ``packages``. If any warning
|
||||
is found, the command will exit with an error code::
|
||||
|
||||
$ python setup.py flake8
|
||||
Loading…
Add table
Add a link
Reference in a new issue