****************
Pre-commit hooks
****************

Hartree Centre pre-commit hooks to use across multiple projects - these have
been developed to hopefully make life simpler, so please raise an issue on
`our repository <https://github.com/stfc/pre-commit-hooks>`_
if you're finding they're more hassle than you'd like!

Documentation for our current hooks are available on the left hand side of
this page.

example configuration:

.. code-block:: yaml
  :caption: .pre-commit-config.yaml

  repos:
      - repo: https://github.com/stfc/pre-commit-hooks
        rev: v0.3.7
        hooks:
          - id: check-mypy-import-errors
          - id: check-pylint-import-errors

TODO: add a worked example of creating a new hook

TODO: add instructions on how to use these hooks within pre-commit-config.yaml

.. hidden 'Home' button as it's often not clear you need to click on the logo
  at the top of the page to get back to this file

.. toctree::
  :hidden:

  Home <self>

.. include all hook documentation:

.. toctree::
  :maxdepth: 1
  :caption: Hooks:
  :glob:

  hooks/*

.. include everything in the modules folder:

.. toctree::
  :maxdepth: 2
  :caption: Functionality:
  :glob:

  utils/*

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

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