minor updates

AlanLoh · Nov 22, 2024 · 010ca2c · 010ca2c
1 parent 6e92126
commit 010ca2c
Show file tree

Hide file tree

Showing 6 changed files with 110 additions and 2 deletions.
diff --git a/docs/source/_autosummary/nenupy.schedule.open_time.NenuCalendar.rst b/docs/source/_autosummary/nenupy.schedule.open_time.NenuCalendar.rst
@@ -0,0 +1,32 @@
+nenupy.schedule.open\_time.NenuCalendar
+=======================================
+
+.. currentmodule:: nenupy.schedule.open_time
+
+.. autoclass:: NenuCalendar
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~NenuCalendar.__init__
+      ~NenuCalendar.from_ics
+      ~NenuCalendar.from_xls
+      ~NenuCalendar.info
+      ~NenuCalendar.month_plot
+      ~NenuCalendar.plot
+      ~NenuCalendar.write_vcr_csv
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/nenupy.schedule.open_time.XLSFile.rst b/docs/source/_autosummary/nenupy.schedule.open_time.XLSFile.rst
@@ -0,0 +1,29 @@
+nenupy.schedule.open\_time.XLSFile
+==================================
+
+.. currentmodule:: nenupy.schedule.open_time
+
+.. autoclass:: XLSFile
+   :members:
+   :show-inheritance:
+   :inherited-members:
+
+
+
+   .. automethod:: __init__
+
+
+   .. rubric:: Methods
+
+   .. autosummary::
+
+      ~XLSFile.__init__
+      ~XLSFile.info
+      ~XLSFile.to_ical
+      ~XLSFile.to_ics
+
+
+
+
+
+
diff --git a/docs/source/_autosummary/nenupy.schedule.open_time.excel_to_ics.rst b/docs/source/_autosummary/nenupy.schedule.open_time.excel_to_ics.rst
@@ -0,0 +1,6 @@
+nenupy.schedule.open\_time.excel\_to\_ics
+=========================================
+
+.. currentmodule:: nenupy.schedule.open_time
+
+.. autofunction:: excel_to_ics
diff --git a/docs/source/_autosummary/nenupy.schedule.open_time.rst b/docs/source/_autosummary/nenupy.schedule.open_time.rst
@@ -0,0 +1,40 @@
+nenupy.schedule.open\_time
+==========================
+
+.. automodule:: nenupy.schedule.open_time
+
+
+
+
+
+
+
+   .. rubric:: Functions
+
+   .. autosummary::
+      :toctree:
+
+      excel_to_ics
+
+
+
+
+
+   .. rubric:: Classes
+
+   .. autosummary::
+      :toctree:
+      :template: custom-class-template.rst
+
+      NenuCalendar
+      NenuEvent
+      XLSFile
+
+
+
+
+
+
+
+
+
diff --git a/docs/source/io/tf_reading.rst b/docs/source/io/tf_reading.rst
@@ -109,7 +109,7 @@ One can access the current state of these parameters by calling
 
 .. code-block:: python
 
-    >>> sp.pipeline.parameters.info()
+    >>> print( sp.pipeline.parameters.info() )
     channels: 64
     dt: 0.02097152 s
     df: 3051.7578125 Hz
@@ -129,6 +129,7 @@ One can access the current state of these parameters by calling
     stokes: I
     ignore_volume_warning: False
 
+.. _custom_pipeline_param_doc:
 
 Pipeline parameter modification
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

diff --git a/nenupy/__init__.py b/nenupy/__init__.py
@@ -5,7 +5,7 @@
 __copyright__ = "Copyright 2023, nenupy"
 __credits__ = ["Alan Loh"]
 __license__ = "MIT"
-__version__ = "2.7.11"
+__version__ = "2.7.12"
 __maintainer__ = "Alan Loh"
 __email__ = "alan.loh@obspm.fr"