.. Particles in box demo documentation master file, created by
   sphinx-quickstart on Fri Jun 11 20:22:22 2021.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Particles in box demo's documentation!
=================================================

This is an example project to show how to set up scientific computing python projects.

.. image:: ./_static/results50s.gif
   :alt: Animation of circles colliding

In the demo we will go through:

 - Basics of git
 - Unit testing with pytest
 - Pre-commit hooks
 - Setting up simple continuous development pipeline
 - Making project documentation with Sphinx
 - Publishing documentation in readthedocs.io

.. toctree::
   :maxdepth: 2
   :caption: Contents:

   instructions_to_run
   documentation


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

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