Add doc workflow

Author: Tom-Willemsen

.github/workflows/documentation.yml

@@ -0,0 +1,8 @@
+name: sphinx
+
+on: [push, pull_request, workflow_call]
+
+jobs:
+  call_sphinx_builder:
+    uses: ISISComputingGroup/reusable-workflows/.github/workflows/sphinx.yml@main
+    secrets: inherit

.gitignore

@@ -160,3 +160,5 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
+
+_build/

docs/Makefile doc/Makefiledocs/Makefile renamed to doc/Makefile

@@ -20,7 +20,7 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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.
-sys.path.insert(0, os.path.abspath("../Lib/site-packages/genie_python/"))
+sys.path.insert(0, os.path.abspath("../src/genie_python/"))
 
 # -- General configuration ------------------------------------------------
 

docs/conf.py doc/conf.pydocs/conf.py renamed to doc/conf.py

@@ -1079,10 +1079,9 @@ def get_time_since_begin(get_timedelta: bool = False) -> float | datetime.timede
             otherwise return seconds (defaults to false)
 
     Returns
-        integer: the time since start in seconds if get_datetime is False
-        timedelta: the time since begin as a datetime.timedelta object
-            (Year-Month-Day  Hour:Minute:Second)
-        if get_datetime is True
+        integer: the time since start in seconds if get_datetime is False,
+            or timedelta, the time since begin as a datetime.timedelta object
+            (Year-Month-Day  Hour:Minute:Second) if get_datetime is True
     """
 
     return _genie_api.dae.get_time_since_begin(get_timedelta)
@@ -2392,6 +2391,7 @@ def get_version() -> str:
 def set_dae_simulation_mode(mode: bool, skip_required_runstates: bool = False) -> None:
     """
     Sets the DAE into simulation mode.
+
     Args:
          mode: True to set the DAE into simulated mode, False to set the DAE into
             non-simulated (hardware) mode

docs/genie_python.rst doc/genie_python.rstdocs/genie_python.rst renamed to doc/genie_python.rst

@@ -1,6 +1,7 @@
 from __future__ import print_function
 
 import ctypes
+import functools
 import glob
 import inspect
 import os
@@ -363,6 +364,7 @@ def log_command_and_handle_exception(f: Callable[P, T]) -> Callable[P, T]:
     accidentally put into a genie function
     """
 
+    @functools.wraps(f)
     def decorator(*args: P.args, **kwargs: P.kwargs) -> T:
         log_args = {"kwargs": kwargs}
         arg_names = getfullargspec(f).args
@@ -380,6 +382,7 @@ def decorator(*args: P.args, **kwargs: P.kwargs) -> T:
         except Exception as e:
             command_exception = traceback.format_exc()
             _handle_exception(e)
+            return None  # type: ignore
         finally:
             end = time.time()
             time_taken = end - start