Bump version and fix docs

Author: evilkermit

build_docs.sh

@@ -1,7 +1,7 @@
 [project]
 name = "nova-epics"
-version = "0.1.0"
-description = "A Python Package for "
+version = "0.2.0"
+description = "A Python Package for retrieving unprivileged instrument status information from EPICS for use in NOVA applications."
 authors = [
     { name = "John Duggan", email = "dugganjw@ornl.gov" }
 ]

pixi.lock

@@ -40,6 +40,17 @@ def _replace_macros(self, pv_name: str, macro_dict: Dict[str, str]) -> str:
         return full_name
 
     def connect(self, xml: str, macros: str, detector_count: int) -> None:
+        """Connects to the EPICS Tomcat server and pulls initial PV values.
+
+        Parameters
+        ----------
+        xml : str
+            The contents of the XML config file for the instrument to pull PVs for.
+        macros : str
+            The macros string for the instrument.
+        detector_count : int
+            The number of detectors used by this instrument.
+        """
         self.server.state["epics"] = {"pv_data": {}}
         bob_dict = parse(xml)
 
@@ -100,13 +111,15 @@ def serve_javascript(self) -> None:
         )
 
     def __init__(self) -> None:
+        """Serves the necessary JavaScript files. This is called by __init__."""
         self.serve_javascript()
 
 
 instance = TrameEPICS()
 
 
 def get_epics_instance() -> TrameEPICS:
+    """Retrieves an instance of the TrameEPICS singleton class."""
     return instance