mirror of
https://github.com/PyCQA/flake8.git
synced 2026-04-04 20:26:53 +00:00
32 lines
618 B
ReStructuredText
32 lines
618 B
ReStructuredText
==============
|
|
Using Flake8
|
|
==============
|
|
|
|
Flake8 can be used in many ways. A few:
|
|
|
|
- invoked on the command-line
|
|
|
|
- invoked via Python
|
|
|
|
- called by Git or Mercurial on or around committing
|
|
|
|
This guide will cover all of these and the nuances for using Flake8.
|
|
|
|
.. note::
|
|
|
|
This portion of Flake8's documentation does not cover installation. See
|
|
the :ref:`installation-guide` section for how to install Flake8.
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
|
|
invocation
|
|
configuration
|
|
options
|
|
ignoring-errors
|
|
python-api
|
|
|
|
.. config files
|
|
.. command-line tutorial
|
|
.. VCS usage
|
|
.. installing and using plugins
|