Add docs/source/install.rst
This commit is contained in:
parent
f66fc53802
commit
e9d5c81f16
docs/source
|
@ -0,0 +1,37 @@
|
||||||
|
Install
|
||||||
|
=====
|
||||||
|
|
||||||
|
.. _installation:
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
To use Lumache, first install it using pip:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
$ hostnamectl set-hostname qpod.webgis1.com
|
||||||
|
$ git clone https://github.com/AcuGIS/quartzmap.git
|
||||||
|
$ cd quartzmap
|
||||||
|
$ ./installer/postgres.sh
|
||||||
|
$ ./installer/app-install.sh
|
||||||
|
|
||||||
|
More
|
||||||
|
----------------
|
||||||
|
|
||||||
|
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']
|
Loading…
Reference in New Issue