.. mdinclude:: ../README.md


.. toctree::
  :maxdepth: 1
  :caption: User guide:
  :hidden:

  pages/usage/setup.rst
  pages/usage/configuration.rst
  pages/usage/violations/index.rst
  pages/usage/formatter.rst


.. toctree::
  :maxdepth: 1
  :caption: Integrations:
  :hidden:

  pages/usage/integrations/index.rst


.. toctree::
  :maxdepth: 2
  :caption: Developer's guide:
  :hidden:

  pages/api/index.rst

.. toctree::
  :maxdepth: 1
  :caption: Changelog:
  :hidden:

  pages/changelog/index.rst


Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`