.. BattDeg documentation master file, created by
   sphinx-quickstart on Tue Mar 19 22:53:55 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BattDeg's documentation!
===================================

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

Start by reading the README.md file here: https://github.com/chintanp/BattDeg/blob/master/README.md and then check out the usage in 
examples folder. 

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

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


.. include:: ../README.md