.. mdinclude:: ../README.md


User guide
-----------

.. toctree::
  :maxdepth: 2
  :caption: Userguide:

  _pages/violations/index.rst
  _pages/constants.rst
  _pages/options/config.rst


Internal docs
-------------

.. toctree::
  :maxdepth: 1
  :caption: API:

  _pages/api.rst


Changelog
---------

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

  _pages/changelog.rst


Indices and tables
==================

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