flake8/docs/source/user/index.rst
Ian Cordasco a7898e0389 Begin adding user-facing documentation
Especially around invocation and configuration
2016-05-26 13:21:25 -05:00

29 lines
582 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
.. config files
.. command-line tutorial
.. VCS usage
.. installing and using plugins