Basic structure

This commit is contained in:
Juan Luis Cano Rodríguez
2021-08-18 10:48:51 +02:00
commit 35d2c35a82
10 changed files with 349 additions and 0 deletions

34
docs/source/usage.rst Normal file
View File

@@ -0,0 +1,34 @@
Usage
=====
.. _installation:
Installation
------------
To use Lumache, first install it using pip:
.. code-block:: console
(.venv) $ pip install lumache
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']