scripts: docs: Make it so numpy docstrings work

Signed-off-by: John Andersen <[email protected]>

Author: pdxjohnny

dffml/operation/dataflow.py

@@ -43,19 +43,19 @@ class run_dataflow(OperationImplementationContext):
     Starts a subflow ``self.config.dataflow`` and adds ``inputs`` in it.
 
     Parameters
-    ++++++++++
+    ----------
     inputs : dict
         The inputs to add to the subflow. These should be a key value mapping of
         the context string to the inputs which should be seeded for that context
         string.
 
     Returns
-    +++++++
+    -------
     dict
         Maps context strings in inputs to output after running through dataflow.
 
     Examples
-    ++++++++
+    --------
 
     The following shows how to use run dataflow in its default behavior.
 

dffml/operation/db.py

@@ -84,14 +84,14 @@ async def db_query_create_table(
     Generates a create table query in the database.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table to be created.
     cols : list[str]
         Columns of the table.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -141,14 +141,14 @@ async def db_query_insert(self, *, table_name: str, data: Dict[str, Any]):
     Generates an insert query in the database.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table to insert data in to.
     data : dict
         Data to be inserted into the table.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -223,7 +223,7 @@ async def db_query_update(
     Generates an Update table query in the database.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table to insert data in to.
     data : dict
@@ -232,7 +232,7 @@ async def db_query_update(
         List of query conditions.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -313,14 +313,14 @@ async def db_query_remove(
     Generates a remove table query in the database.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table to insert data in to.
     conditions : Conditions
         Query conditions.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -395,7 +395,7 @@ async def db_query_lookup(
     Generates a lookup query in the database.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table.
     cols : list[str]
@@ -404,7 +404,7 @@ async def db_query_lookup(
         Query conditions.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -466,14 +466,14 @@ async def db_query_insert_or_update(
     Automatically uses the better suited operation, insert query or update query.
 
     Parameters
-    ++++++++++
+    ----------
     table_name : str
         The name of the table to insert data in to.
     data : dict
         Data to be inserted or updated into the table.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *

dffml/operation/io.py

@@ -40,12 +40,12 @@ class AcceptUserInput(OperationImplementation):
     Accept input from stdin using python input()
 
     Returns
-    +++++++
+    -------
     dict
         A dictionary containing user input.
 
     Examples
-    ++++++++
+    --------
 
     The following example shows how to use AcceptUserInput.
     (Assumes that the input from stdio is "Data flow is awesome"!)
@@ -97,12 +97,12 @@ async def print_output(data: Any):
     Print the output on stdout using python print()
 
     Parameters
-    ++++++++++
+    ----------
     data : Any
         A python literal to be printed.
 
     Examples
-    ++++++++
+    --------
 
     The following example shows how to use print_output.
 

dffml/operation/mapping.py

@@ -20,19 +20,19 @@ def mapping_extract_value(mapping: Dict[str, Any], traverse: List[str]):
     Extracts value from a given mapping.
 
     Parameters
-    ++++++++++
+    ----------
     mapping : dict
         The mapping to extract the value from.
     traverse : list[str]
         A list of keys to traverse through the mapping dictionary and extract the values.
 
     Returns
-    +++++++
+    -------
     dict
         A dictionary containing the value of the keys.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *
@@ -76,19 +76,19 @@ def create_mapping(key: str, value: Any):
     Creates a mapping of a given key and value.
 
     Parameters
-    ++++++++++
+    ----------
     key : str
         The key for the mapping.
     value : Any
         The value for the mapping.
 
     Returns
-    +++++++
+    -------
     dict
         A dictionary containing the mapping created.
 
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *

dffml/operation/math.py

@@ -17,19 +17,19 @@ async def multiply(multiplicand, multiplier):
     Multiply record values
 
     Parameters
-    ++++++++++
+    ----------
     multiplicand : generic
         An arithmetic type value.
     multiplier : generic
         An arithmetic type value.
 
     Returns
-    +++++++
+    -------
     dict
         A dict containing the product.
 
     Examples
-    ++++++++
+    --------
 
     The following example shows how to use multiply.
 

dffml/operation/model.py

@@ -41,17 +41,17 @@ async def model_predict(self, features: Dict[str, Any]) -> Dict[str, Any]:
     Predict using dffml models.
 
     Parameters
-    ++++++++++
+    ----------
     features : dict
         A dictionary contaning feature name and feature value.
 
     Returns
-    +++++++
+    -------
     dict
         A dictionary containing prediction.
 
     Examples
-    ++++++++
+    --------
 
     The following example shows how to use model_predict.
 

dffml/operation/output.py

@@ -118,18 +118,18 @@ class GetMulti(OperationImplementationContext):
     Output operation to get all Inputs matching given definitions.
 
     Parameters
-    ++++++++++
+    ----------
     spec : list
         List of definition names. Any Inputs with matching definition will be
         returned.
 
     Returns
-    +++++++
+    -------
     dict
         Maps definition names to all the Inputs of that definition
 
     Examples
-    ++++++++
+    --------
 
     The following shows how to grab all Inputs with the URL definition. If we
     had we run an operation which output a URL, that output URL would have also
@@ -216,18 +216,18 @@ class GetSingle(GetMulti):
     Output operation to get a single Input for each definition given.
 
     Parameters
-    ++++++++++
+    ----------
     spec : list
         List of definition names. An Input with matching definition will be
         returned.
 
     Returns
-    +++++++
+    -------
     dict
         Maps definition names to an Input of that definition
 
     Examples
-    ++++++++
+    --------
 
     The following shows how to grab an Inputs with the URL definition. If we
     had we run an operation which output a URL, that output URL could have also
@@ -322,7 +322,7 @@ async def run(self, inputs: Dict[str, Any]) -> Dict[str, Any]:
 class AssociateDefinition(OperationImplementationContext):
     """
     Examples
-    ++++++++
+    --------
 
     >>> import asyncio
     >>> from dffml import *

dffml/operation/preprocess.py

@@ -19,17 +19,17 @@ async def literal_eval(str_to_eval: str):
     Evaluate the input using ast.literal_eval()
 
     Parameters
-    ++++++++++
+    ----------
     str_to_eval : str
         A string to be evaluated.
 
     Returns
-    +++++++
+    -------
     dict
         A dict containing python literal.
 
     Examples
-    ++++++++
+    --------
 
     The following example shows how to use literal_eval.
 

scripts/docs.py

@@ -203,7 +203,7 @@ def gen_docs(
                     "tag": f".. _plugin_{plugin_type}_{name}:",
                     "name": name,
                     "install": name.replace("_", "-"),
-                    "underline": "-" * len(name),
+                    "underline": "+" * len(name),
                 }
             )
             + (