From 2b30c240b72446aa75b0e81ba9c614596112da43 Mon Sep 17 00:00:00 2001 From: AcuGIS Date: Mon, 25 Mar 2024 10:43:01 +0000 Subject: [PATCH] Update docs/source/permalinks.rst --- docs/source/permalinks.rst | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/docs/source/permalinks.rst b/docs/source/permalinks.rst index e25a894..b1ceeaf 100644 --- a/docs/source/permalinks.rst +++ b/docs/source/permalinks.rst @@ -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