Skip to content

Commit

Permalink
Merge pull request #1 from vmasc-capabilities-lab/pr-test
Browse files Browse the repository at this point in the history
clean up and pr test
  • Loading branch information
BrandonFeldhaus committed Dec 7, 2022
2 parents d8f1b0e + 545e0ca commit a834249
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 47 deletions.
7 changes: 0 additions & 7 deletions docs/source/api.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/getting-started.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
Getting Started
=====
=====
8 changes: 1 addition & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ Welcome to Datacube.Online!
The Virginia Open Datacube is a custom deployment of the Open Datacube utilizing `the Littlest JupyterHub <https://tljh.jupyter.org/en/latest/>` which pulls data from multiple sources, including the `AWS Registry of Open Data https://registry.opendata.aws/` and offers a powerful computational environment for performing time-series analyses from spatiotemporal datasets, especially those collected by various public satellites.

Check out the :doc:`usage` section for further information, including
how to :ref:`installation` the project.

.. note::

Expand All @@ -18,9 +17,4 @@ Contents
.. toctree::

getting-started
usage
data products
utilities
sample notebooks
collaboration and sharing
TEST DOCUMENTATION UPDATE
usage
32 changes: 0 additions & 32 deletions docs/source/usage.rst
Original file line number Diff line number Diff line change
@@ -1,34 +1,2 @@
Usage
=====

.. _installation:

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

To use Lumache, first install it using pip:

.. code-block:: console
(.venv) $ pip install lumache
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']

0 comments on commit a834249

Please sign in to comment.