API Reference
=============

Internal documentation.

Here you can find:

1. How our development process works
2. How to contribute to the project
3. How to write new rules

This information will also be helpful
if you would like to create our own ``flake8`` plugin.

How to read this documentation
------------------------------

You will need to start from the :ref:`glossary <glossary>`
where we define the terms for this project.

Then move to the :ref:`contributing <contributing>` guide
where we specify all technical details about our workflow and tools.

And finally you will need to go through the API reference.

.. toctree::
  :maxdepth: 2
  :caption: Meta:

  glossary.rst
  contributing.rst

.. toctree::
  :maxdepth: 2
  :caption: API Reference:

  checker.rst
  visitors/base.rst
  violations/base.rst