AcuGIS
/
QuartzMap
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update docs/source/permalinks.rst

This commit is contained in:
AcuGIS 2024-03-25 10:43:01 +00:00
parent 83fc15094a
commit 2b30c240b7
1 changed files with 5 additions and 23 deletions
docs/source
permalinks.rst

28
docs/source/permalinks.rst
View File

@ -3,32 +3,14 @@ Permalinks
.. _installation: .. _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 .. image:: images/Permalinks-3.png
----------------
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']