Skip to content

Commit

Permalink
docs updated
Browse files Browse the repository at this point in the history
  • Loading branch information
borisbrue committed Dec 3, 2021
1 parent c222943 commit 004f267
Showing 1 changed file with 1 addition and 31 deletions.
32 changes: 1 addition & 31 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,4 @@
Usage
=====

.. _installation:

Installation
------------

To use Lumache, first install it using pip:

.. code-block:: console
(.venv) $ pip install wagtail_tenants
Creating recipes
----------------

To retrieve a list of random ingredients,
you can use the ``wagtail_tenants.get_random_ingredients()`` function:

.. autofunction:: wagtail_tenants.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:: wagtail_tenants.InvalidKindError

For example:

>>> import wagtail_tenants
>>> wagtail_tenants.get_random_ingredients()
['shells', 'gorgonzola', 'parsley']

Under development

0 comments on commit 004f267

Please sign in to comment.