-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add template rst files for readthedocs
- Loading branch information
1 parent
5dc727b
commit 4b4433f
Showing
3 changed files
with
61 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
API | ||
=== | ||
|
||
.. autosummary:: | ||
:toctree: generated | ||
|
||
chiltepin |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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'] |