Edited docs index

docs/conf.py

@@ -14,14 +14,15 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("."))
 
 
 # -- Project information -----------------------------------------------------
 
-project = "recipe tagger"
+project = "Recipe Tagger"
 copyright = "2022, Andrea Turconi"
 author = "Andrea Turconi"
 

docs/index.rst

@@ -3,27 +3,14 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to recipe tagger's documentation!
+Recipe Tagger's documentation!
 =========================================
 
 This package provides a classification, a tagging system and a water footprint calculator for ingredients and recipes.
 The functioning of the package is based on a dataset containing more than 700 ingredients mapped with their own class and water footprint. If a provided ingredient is not mapped into the dataset, the library search for it on wikipedia pages, into the dictionary and into NLTK Wordnet to find the best possible class. The water footprint is computed based on its ingredients. Every ingredient has a water footprint, measured in l/kg.
 
-An ingredient could be classified in one of the following class:
-- Vegetable
-- Fruit
-- Legume
-- Meat
-- Egg
-- Diary
-- Staple
-- Condiment
-- Nut
-- Seafood
-- Snack
-- Mushroom
-- Dessert
-- Beverage
+An ingredient could be classified in one of the following class: Vegetable, Fruit, Legume, Meat, Egg, Diary, Staple,
+Condiment, Nut, Seafood, Snack, Mushroom, Dessert, Beverage.
 
 A recipe is tagged based on its ingredients class. The library also provides a function to get the class percentage of recipe ingredients.
 

docs/modules.rst

@@ -0,0 +1,9 @@
+food-recipe-tagger
+==================
+
+.. toctree::
+   :maxdepth: 4
+
+   recipe_tagger
+   setup
+   tests

docs/recipe_tagger.rst

@@ -0,0 +1,45 @@
+recipe\_tagger package
+======================
+
+Submodules
+----------
+
+recipe\_tagger.foodcategory module
+----------------------------------
+
+.. automodule:: recipe_tagger.foodcategory
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+recipe\_tagger.recipe\_tagger module
+------------------------------------
+
+.. automodule:: recipe_tagger.recipe_tagger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+recipe\_tagger.recipe\_waterfootprint module
+--------------------------------------------
+
+.. automodule:: recipe_tagger.recipe_waterfootprint
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+recipe\_tagger.util module
+--------------------------
+
+.. automodule:: recipe_tagger.util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: recipe_tagger
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/setup.rst

@@ -0,0 +1,7 @@
+setup module
+============
+
+.. automodule:: setup
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/tests.rst

@@ -0,0 +1,37 @@
+tests package
+=============
+
+Submodules
+----------
+
+tests.test\_recipe\_tagger module
+---------------------------------
+
+.. automodule:: tests.test_recipe_tagger
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tests.test\_recipe\_waterfootprint module
+-----------------------------------------
+
+.. automodule:: tests.test_recipe_waterfootprint
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+tests.test\_util module
+-----------------------
+
+.. automodule:: tests.test_util
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: tests
+   :members:
+   :undoc-members:
+   :show-inheritance: