From df39998064b5a656a8e12b05c0d6f6fc4f3edf35 Mon Sep 17 00:00:00 2001 From: TheJoKlLa Date: Mon, 13 May 2024 13:09:31 +0200 Subject: [PATCH] Fixed Exampl --- docs/api.md | 1 - docs/index.md | 11 ----------- docs/usage.md | 31 ------------------------------- 3 files changed, 43 deletions(-) diff --git a/docs/api.md b/docs/api.md index 24b0824..ecbc0fb 100644 --- a/docs/api.md +++ b/docs/api.md @@ -1,3 +1,2 @@ # API Reference -::: lumache diff --git a/docs/index.md b/docs/index.md index d489af8..1df4d0b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,14 +2,3 @@ # Welcome to Lumache's documentation! -**Lumache** (/lu\'make/) is a Python library for cooks and food lovers -that creates recipes mixing random ingredients. It pulls data from the -[Open Food Facts database](https://world.openfoodfacts.org/) and offers -a *simple* and *intuitive* API. - -Check out the [usage](usage) section for further information, including how to [install](usage#installation) the project. - -!!! note - - This project is under active development. - diff --git a/docs/usage.md b/docs/usage.md index efd1a2a..5aee3e3 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -1,34 +1,3 @@ Usage ===== -Installation ------------- - -To use Lumache, first install it using pip: - -```console -(.venv) $ pip install lumache -``` - -Creating recipes ----------------- - -To retrieve a list of random ingredients, you can use the -`lumache.get_random_ingredients()` function: - -::: lumache.get_random_ingredients - options: - show_root_heading: true - -
- -The `kind` parameter should be either `"meat"`, `"fish"`, or `"veggies"`. -Otherwise, [`get_random_ingredients`][lumache.get_random_ingredients] will raise an exception [`lumache.InvalidKindError`](/api#lumache.InvalidKindError). - -For example: - -```python ->>> import lumache ->>> lumache.get_random_ingredients() -['shells', 'gorgonzola', 'parsley'] -```