Skip to content

Commit

Permalink
Add template rst files for readthedocs
Browse files Browse the repository at this point in the history
  • Loading branch information
christopherwharrop-noaa committed Oct 2, 2024
1 parent 5dc727b commit 4b4433f
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
API
===

.. autosummary::
:toctree: generated

chiltepin
20 changes: 20 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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
34 changes: 34 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
@@ -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']

0 comments on commit 4b4433f

Please sign in to comment.