Merge branch 'main' of https://github.com/brightway-lca/bw_hestia_bridge

brightway-lca · Sep 20, 2023 · a22602c · a22602c
2 parents d1701a4 + 8042afc
commit a22602c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 18 deletions.
diff --git a/bw_hestia_bridge/hestia_api/cycle_graph.py b/bw_hestia_bridge/hestia_api/cycle_graph.py
@@ -12,25 +12,25 @@ def get_cycle_graph(cycle_id: str) -> list[dict]:
     Parameters
     ----------
     cycle_id : str
-        Hestia ID of the initial cycle.
+        Hestia ID of the initial cycle
 
     Returns
     -------
-    List of cycles of the form: ::
+    List of cycles of the form : list[dict]
+        ::
 
-        [
-            {
-                "from": {@type="Cycle", @id: PARENT_CYCLE_ID},
-                "to": {@type: "Cycle", @id: CHILD_CYCLE_ID},
-                "via": {@type: "Term", @id: PRODUCT_TERM_ID}
-            },
-            ...
-        ]
+            [
+                {
+                    "from": {"@type": "Cycle", "@id": PARENT_CYCLE_ID},
+                    "to": {"@type": "Cycle", "@id": CHILD_CYCLE_ID},
+                    "via": {"@type": "Term", "@id": PRODUCT_TERM_ID}
+                }, ...
+            ]
 
     Raises
     ------
-    ``ValueError`` if `cycle_id` is not found.
-    '''
+    ValueError
+        if `cycle_id` is not found
     """
     q: dict[str, Union[int, str]] = {
         "limit": 10000,

diff --git a/bw_hestia_bridge/hestia_api/querying.py b/bw_hestia_bridge/hestia_api/querying.py
@@ -40,9 +40,10 @@ def search_hestia(
 
     Returns
     -------
-    A list of dicts containing the `fields` entries. Additionally, a "_score"
-    value is returned, indicating the accuracy of the match found in the
-    Hestia database (results are sorted by decreasing "_score").
+    res : list[dict]
+        A list of dicts containing the `fields` entries. Additionally, a
+        "_score" value is returned, indicating the accuracy of the match found
+        in the Hestia database (results are sorted by decreasing "_score").
 
     Examples
     --------
@@ -134,8 +135,9 @@ def get_hestia_node(
 
     Returns
     -------
-    The dict associated to the JSON-LD entry describing `node` in the
-    Hestia database.
+    node : dict
+        The dict associated to the JSON-LD entry describing `node` in the
+        Hestia database.
     """
     if isinstance(node_id, dict):
         assert "@type" in node_id, "`node` must contain an '@type' entry."
@@ -165,9 +167,14 @@ def get_node_type(node_id: str) -> str:
     node_id : str
         Hestia ID for the node.
 
+    Returns
+    -------
+    node_type : str
+        The type of the node.
+
     Raises
     ------
-    ``ValueError`` if `node_id` is not found.
+    ValueError : if `node_id` is not found.
     """
     res = search_hestia({"@id": node_id}, how="exact")
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -26,6 +26,7 @@
     'sphinx.ext.intersphinx',
     'sphinx.ext.extlinks',
     'sphinx.ext.inheritance_diagram',
+    'sphinx.ext.napoleon',
     # iPython extensions
     'IPython.sphinxext.ipython_directive',
     'IPython.sphinxext.ipython_console_highlighting',