MLDJANGO
=========
Welcome to the Mono Lake Dashboard Repository. The Mono Lake Dashboard is a presentation of prehistoric, current, and model data, background information, and impacts presented on a website with dynamic and static products.
In this documentation, we write up the development of the dashboard, including the description of all functions, code, and data.

If you're here as a developer, you're in the right place!

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

   manualdocs/contents
   autodocs/modules

Installation
--------------
1. **Clone the Repository**: Grab the clone link from the Github Clone Button & run the following command in your terminal

.. code-block:: bash

   $ git clone REPOSITORY_CLONE_LINK

2. **Use pipenv**: We're using pipenv to package manage the project. After cloning the repo, run the following commands:

.. code-block:: bash
   
   # If you don't already have pipenv, install with the following
   $ pip install pipenv
   # Run the following command (inside the repo folder!)
   $ pipenv install


Documentation
---------------
All documentation is in the docs folder.

#. **To Read Documentation**: Go to docs/_build/html/index.html. Open it in a browser of your chose
#. **To Update the Docs**: Run the following code from inside the docs folder:

.. code-block:: bash

   sphinx-apidoc -o autodocs/ ../mldjango/mld
   make html