Skip to content

Commit 038369c

Browse files
committed
[new] docs stub
1 parent bf73999 commit 038369c

File tree

4 files changed

+8
-41
lines changed

4 files changed

+8
-41
lines changed

docs/source/api.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
# -- Project information
44

5-
project = 'Lumache'
6-
copyright = '2021, Graziella'
7-
author = 'Graziella'
5+
project = 'TensorType'
6+
copyright = ''
7+
author = 'Bruno Gavranovic'
88

99
release = '0.1'
1010
version = '0.1.0'

docs/source/index.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
Welcome to Lumache's documentation!
1+
Welcome to TensorType's documentation!
22
===================================
33

4-
**Lumache** (/lu'make/) is a Python library for cooks and food lovers
5-
that creates recipes mixing random ingredients.
6-
It pulls data from the `Open Food Facts database <https://world.openfoodfacts.org/>`_
7-
and offers a *simple* and *intuitive* API.
4+
Framework for type-safe pure functional and non-cubical tensor processing, written in Idris 2.
5+
6+
TODO
87

98
Check out the :doc:`usage` section for further information, including
109
how to :ref:`installation` the project.
@@ -19,4 +18,3 @@ Contents
1918
.. toctree::
2019

2120
usage
22-
api

docs/source/usage.rst

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,5 @@ Usage
66
Installation
77
------------
88

9-
To use Lumache, first install it using pip:
10-
11-
.. code-block:: console
12-
13-
(.venv) $ pip install lumache
14-
15-
Creating recipes
16-
----------------
17-
18-
To retrieve a list of random ingredients,
19-
you can use the ``lumache.get_random_ingredients()`` function:
20-
21-
.. autofunction:: lumache.get_random_ingredients
22-
23-
The ``kind`` parameter should be either ``"meat"``, ``"fish"``,
24-
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients`
25-
will raise an exception.
26-
27-
.. autoexception:: lumache.InvalidKindError
28-
29-
For example:
30-
31-
>>> import lumache
32-
>>> lumache.get_random_ingredients()
33-
['shells', 'gorgonzola', 'parsley']
9+
To use TensorType, first ...
3410

0 commit comments

Comments
 (0)