Update docs/source/permalinks.rst
This commit is contained in:
parent
83fc15094a
commit
2b30c240b7
|
@ -3,32 +3,14 @@ Permalinks
|
|||
|
||||
.. _installation:
|
||||
|
||||
Installation
|
||||
Usage
|
||||
------------
|
||||
|
||||
To use Lumache, first install it using pip:
|
||||
.. image:: images/Permalink-1.png
|
||||
|
||||
.. code-block:: console
|
||||
.. image:: images/Permalink-4.png
|
||||
|
||||
(.venv) $ pip install lumache
|
||||
.. image:: images/Permalinks-2.png
|
||||
|
||||
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']
|
||||
.. image:: images/Permalinks-3.png
|
||||
|
||||
|
|
Loading…
Reference in New Issue