.. mdinclude:: ../README.md

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

  pages/usage.rst
  pages/violations/index.rst
  pages/constants.rst
  pages/options/config.rst

.. toctree::
  :maxdepth: 2
  :caption: API:
  :hidden:

  pages/api.rst

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

  pages/changelog.rst


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

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