.. PyCatSim documentation master file, created by
   sphinx-quickstart on Fri May 23 13:23:36 2025.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

PyCatSim
=========

PyCatSim is a toy Python package that simulates cats and their associated humans and environment. The package is meant to teach packaging techniques and proper documentation. 

Getting Started
===============

.. toctree::
   :caption: Playing with PyCatSim
   :maxdepth: 1
   
   installation.rst
   api.rst
   
.. toctree::
   :caption: Advanced functionalities
   :maxdepth: 1
   
   utils.rst

Getting Involved
================

.. toctree::
   :Hidden:
   :caption: Getting Involved
   :maxdepth: 1

   citation.rst
   contribution_guide.rst

PyCatSim has been made freely available under the terms of the `Apache 2.0 License <https://github.com/khider/pyCatSim/blob/main/LICENSE>`_. There are many ways to get involved :ref:`with the development of PyCatSim<contributing_to_pycatsim>`:

* If you write a paper making use of PyCatSim, please cite it :ref:`thus <citing_pycatsim>`.
* Report bugs and problems with the code or documentation to our `GitHub repository <https://github.com/khider/pyCatSim/issues>`_. Please make sure that there is not outstanding issues that cover the problem you're experiencing.
  * Contribute bug fixes
  * Contribute enhancements and new features
  * Contribute to the code documentation

Search PyCatSim
================

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