.. title:: PySherlock documentation

.. figure:: _static/logo/logo.png
   :align: center
   :width: 640px

PySherlock is a Python client library for the Ansys Sherlock product. You are
viewing version |version|.

.. grid:: 1 1 3 3

  .. grid-item-card:: :fa:`power-off` Getting started
      :link: getting_started/index
      :link-type: doc
      :padding: 2 2 2 2

      Learn about PySherlock and how to get started.

  .. grid-item-card:: :fa:`list-alt` User guide
      :link: user_guide/index
      :link-type: doc
      :padding: 2 2 2 2

      Understand how to use PySherlock to perform various tasks.

  .. grid-item-card:: :fa:`wrench` API reference
      :link: api/index
      :link-type: doc
      :padding: 2 2 2 2

      A detailed guide describing the API of PySherlock.

  .. grid-item-card:: :fa:`user-group` Contribute
     :link: contributing
     :link-type: doc
     :padding: 2 2 2 2

     Learn how to contribute to the project and become a part of the PySherlock
     community.

  .. grid-item-card:: Examples :fa:`scroll`
     :link: changelog
     :link-type: doc
     :padding: 2 2 2 2

     View the changelog to see what's new in the latest version of PySherlock.


.. toctree::
    :maxdepth: 3
    :hidden:

    getting_started/index
    user_guide/index
    api/index
    contributing
    changelog