Skip to content

Commit

Permalink
Bug fix for building docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aecelaya committed Mar 30, 2024
1 parent 2a2f9dd commit b4ff05f
Showing 1 changed file with 2 additions and 25 deletions.
27 changes: 2 additions & 25 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,8 @@ Getting Started
Installation
------------

To use Lumache, first install it using pip:
To use MIST, 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

<br>

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']
pip install mist-medical
```

0 comments on commit b4ff05f

Please sign in to comment.