flake8/docs/source/user/index.rst
Ian Cordasco 107f595d13
Add flake8.api and docs for it
Stub out the primary method people seem to use.
2016-06-08 11:48:36 -05:00

32 lines
629 B
ReStructuredText

==============
Using Flake8
==============
Flake8 can be used in many ways:
- invoking it on the command-line
- invoking it via Python
- having it 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