Add API documentation for currents, plotting, simulator, types, and utils modules

Author: RaulSimpetru

docs/source/api/currents_api.rst

@@ -0,0 +1,18 @@
+Current Generation
+==================
+
+This module contains functions for generating various input current waveforms (ramp, step, sinusoidal, etc.).
+
+
+.. currentmodule:: myogen.utils.currents
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/function.rst
+   :recursive:
+
+   create_ramp_current
+   create_step_current
+   create_sinusoidal_current
+   create_sawtooth_current
+   create_trapezoid_current 

docs/source/api/plotting_api.rst

@@ -0,0 +1,18 @@
+Plotting & Visualization
+========================
+
+This module contains functions for visualizing simulation results and analysis.
+All functions will return an Axes or a list of Axes for use in matplotlib.
+
+.. currentmodule:: myogen.utils.plotting
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/function.rst
+   :recursive:
+
+   plot_recruitment_thresholds
+   plot_spike_trains
+   plot_surface_emg
+   plot_muap_grid
+   plot_input_current__matrix 

docs/source/api/simulator_api.rst

@@ -0,0 +1,44 @@
+Simulator Module
+================
+
+.. currentmodule:: myogen.simulator
+
+Motor Unit Recruitment Thresholds
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/function.rst
+   :recursive:
+
+   generate_mu_recruitment_thresholds
+
+Motor Neuron Pool
+^^^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/class.rst
+   :recursive:
+
+   MotorNeuronPool
+
+Muscle Model
+^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/class.rst
+   :recursive:
+
+   Muscle
+
+EMG Generation
+^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/class.rst
+   :recursive:
+
+   SurfaceEMG 

docs/source/api/types_api.rst

@@ -0,0 +1,16 @@
+Type Definitions
+================
+
+This module contains type definitions for structured data and type safety.
+
+.. currentmodule:: myogen.utils.types
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/data.rst
+   :recursive:
+
+   INPUT_CURRENT__MATRIX
+   SPIKE_TRAIN__MATRIX
+   MUAP_SHAPE__TENSOR
+   SURFACE_EMG__TENSOR 

docs/source/api/utils_api.rst

@@ -0,0 +1,32 @@
+Utils Module
+============
+
+This module contains utility functions for setup, NMODL file handling, current generation, plotting, and type definitions.
+
+The utils module is organized into the following submodules:
+    - currents
+    - plotting
+    - types
+
+.. currentmodule:: myogen.utils
+
+Setup Functions
+^^^^^^^^^^^^^^^
+
+.. autosummary::
+   :toctree: ../generated/
+   :template: autosummary/function.rst
+   :recursive:
+
+   setup_myogen
+   load_nmodl_files
+
+Submodules
+^^^^^^^^^^	
+
+.. toctree::
+   :maxdepth: 1
+
+   currents_api
+   plotting_api
+   types_api