add documentation for defined entrypoints

Author: jcschaff

docs/modules.md

@@ -1,5 +1,21 @@
 # Modules
 
-## libvcell.libvcell
+## libvcell
 
-::: libvcell.libvcell
+::: libvcell
+
+# Modules
+
+## libvcell
+
+::: libvcell
+
+### Functions
+
+#### sbml_to_finite_volume_input
+
+::: libvcell.solver_utils.sbml_to_finite_volume_input
+
+#### vcml_to_finite_volume_input
+
+::: libvcell.solver_utils.vcml_to_finite_volume_input

libvcell/solver_utils.py

@@ -4,12 +4,33 @@
 
 
 def vcml_to_finite_volume_input(vcml_content: str, simulation_name: str, output_dir_path: Path) -> tuple[bool, str]:
+    """
+    Convert VCML content to finite volume input files
+
+    Args:
+        vcml_content (str): VCML content
+        simulation_name (str): simulation name
+        output_dir_path (Path): output directory path
+
+    Returns:
+        tuple[bool, str]: A tuple containing the success status and a message
+    """
     native = VCellNativeCalls()
     return_value: ReturnValue = native.vcml_to_finite_volume_input(vcml_content, simulation_name, output_dir_path)
     return return_value.success, return_value.message
 
 
 def sbml_to_finite_volume_input(sbml_content: str, output_dir_path: Path) -> tuple[bool, str]:
+    """
+    Convert SBML content to finite volume input files
+
+    Args:
+        sbml_content (str): SBML content
+        output_dir_path (Path): output directory path
+
+    Returns:
+        tuple[bool, str]: A tuple containing the success status and a message
+    """
     native = VCellNativeCalls()
     return_value: ReturnValue = native.sbml_to_finite_volume_input(sbml_content, output_dir_path)
     return return_value.success, return_value.message