summaryrefslogtreecommitdiff
path: root/docs/source/user/index.rst
blob: 90d5b14e4748a94402c3483dbbeeea121b09f402 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
==============
 Using Flake8
==============

|Flake8| can be used in many ways. A few:

- invoked on the command-line

- invoked via Python

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
    error-codes
    violations
    using-plugins
    using-hooks
    python-api

.. config files
.. command-line tutorial
.. VCS usage
.. installing and using plugins