From 4b4433fef058d8e86ea6aba22d2929a49978729d Mon Sep 17 00:00:00 2001
From: Christopher Harrop <Christopher.W.Harrop@noaa.gov>
Date: Wed, 2 Oct 2024 14:54:43 -0500
Subject: [PATCH] Add template rst files for readthedocs

---
 docs/api.rst   |  7 +++++++
 docs/index.rst | 20 ++++++++++++++++++++
 docs/usage.rst | 34 ++++++++++++++++++++++++++++++++++
 3 files changed, 61 insertions(+)
 create mode 100644 docs/api.rst
 create mode 100644 docs/index.rst
 create mode 100644 docs/usage.rst

diff --git a/docs/api.rst b/docs/api.rst
new file mode 100644
index 00000000..780ae205
--- /dev/null
+++ b/docs/api.rst
@@ -0,0 +1,7 @@
+API
+===
+
+.. autosummary::
+   :toctree: generated
+
+   chiltepin
diff --git a/docs/index.rst b/docs/index.rst
new file mode 100644
index 00000000..eda3edf9
--- /dev/null
+++ b/docs/index.rst
@@ -0,0 +1,20 @@
+Welcome to ExascaleWorkflowSandbox's documentation!
+===================================
+
+**ExascaleWorkflowSandbox** is a Python library for exploring federated
+workflow capabilities using Parsl and Globus Compute.
+
+Check out the :doc:`usage` section for further information, including
+how to :ref:`installation` the project.
+
+.. note::
+
+   This project is under active development.
+
+Contents
+--------
+
+.. toctree::
+
+   usage
+   api
diff --git a/docs/usage.rst b/docs/usage.rst
new file mode 100644
index 00000000..40eb7821
--- /dev/null
+++ b/docs/usage.rst
@@ -0,0 +1,34 @@
+Usage
+=====
+
+.. _installation:
+
+Installation
+------------
+
+To use ExascaleWorkflowSandbox, first install it using pip:
+
+.. code-block:: console
+
+   (.venv) $ pip install chiltepin
+
+..
+  Creating recipes
+  ----------------
+  
+  To retrieve a list of random ingredients,
+  you can use the ``lumache.get_random_ingredients()`` function:
+  
+  .. autofunction:: lumache.get_random_ingredients
+  
+  The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
+  or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
+  will raise an exception.
+  
+  .. autoexception:: lumache.InvalidKindError
+  
+  For example:
+  
+  >>> import lumache
+  >>> lumache.get_random_ingredients()
+  ['shells', 'gorgonzola', 'parsley']