Update doc

Cogitate-consortium · Aug 27, 2024 · e309ded · e309ded
1 parent 4b49f9b
commit e309ded
Show file tree

Hide file tree

Showing 41 changed files with 4,406 additions and 53 deletions.
diff --git a/cog_plot/colors.py b/cog_plot/colors.py
@@ -7,6 +7,7 @@
 
 Color Categories:
 -----------------
+
 - "iit": A specific color for IIT (e.g., Integrated Information Theory).
 - "gnw": A specific color for GNW (e.g., Global Neuronal Workspace).
 - "task relevant": A color indicating task-relevant elements.
@@ -23,14 +24,14 @@
 
 Example Usage:
 --------------
+
 To use a specific color in a plot:
 
-    >>> import matplotlib.pyplot as plt
-    >>> color = DEFAULT_COLORS['iit']
-    >>> plt.plot(data, color=color)
+  >>> import matplotlib.pyplot as plt
+  >>> color = DEFAULT_COLORS['iit']
+  >>> plt.plot(data, color=color)
 """
 
-
 DEFAULT_COLORS = {
     "iit": [
       0.00392156862745098,

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c217ef42cdc8569d93e7ed95996e6b03
+config: d683d1f5691da2c4a19f6c17d431aa8b
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/colors.doctree b/docs/.doctrees/colors.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/generated/cog_plot.colors.DEFAULT_COLORS.doctree b/docs/.doctrees/generated/cog_plot.colors.DEFAULT_COLORS.doctree
diff --git a/docs/.doctrees/generated/cog_plot.plot_matrix.doctree b/docs/.doctrees/generated/cog_plot.plot_matrix.doctree
diff --git a/docs/.doctrees/generated/cog_plot.plot_time_series.doctree b/docs/.doctrees/generated/cog_plot.plot_time_series.doctree
diff --git a/docs/.doctrees/generated/cog_plot.plotters.plot_matrix.doctree b/docs/.doctrees/generated/cog_plot.plotters.plot_matrix.doctree
diff --git a/docs/.doctrees/generated/cog_plot.plotters.plot_rasters.doctree b/docs/.doctrees/generated/cog_plot.plotters.plot_rasters.doctree
diff --git a/docs/.doctrees/generated/cog_plot.plotters.plot_time_series.doctree b/docs/.doctrees/generated/cog_plot.plotters.plot_time_series.doctree
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/plotters.doctree b/docs/.doctrees/plotters.doctree
diff --git a/docs/_sources/colors.rst.txt b/docs/_sources/colors.rst.txt
@@ -0,0 +1,12 @@
+Colors Module
+=============
+
+.. automodule:: cog_plot.colors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autosummary::
+   :toctree: generated/
+
+   DEFAULT_COLORS
diff --git a/docs/_sources/generated/cog_plot.colors.DEFAULT_COLORS.rst.txt b/docs/_sources/generated/cog_plot.colors.DEFAULT_COLORS.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.colors.DEFAULT\_COLORS
+================================
+
+.. currentmodule:: cog_plot.colors
+
+.. autodata:: DEFAULT_COLORS
diff --git a/docs/_sources/generated/cog_plot.plot_matrix.rst.txt b/docs/_sources/generated/cog_plot.plot_matrix.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.plot\_matrix
+======================
+
+.. currentmodule:: cog_plot
+
+.. autofunction:: plot_matrix
diff --git a/docs/_sources/generated/cog_plot.plot_time_series.rst.txt b/docs/_sources/generated/cog_plot.plot_time_series.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.plot\_time\_series
+============================
+
+.. currentmodule:: cog_plot
+
+.. autofunction:: plot_time_series
diff --git a/docs/_sources/generated/cog_plot.plotters.plot_matrix.rst.txt b/docs/_sources/generated/cog_plot.plotters.plot_matrix.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.plotters.plot\_matrix
+===============================
+
+.. currentmodule:: cog_plot.plotters
+
+.. autofunction:: plot_matrix
diff --git a/docs/_sources/generated/cog_plot.plotters.plot_rasters.rst.txt b/docs/_sources/generated/cog_plot.plotters.plot_rasters.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.plotters.plot\_rasters
+================================
+
+.. currentmodule:: cog_plot.plotters
+
+.. autofunction:: plot_rasters
diff --git a/docs/_sources/generated/cog_plot.plotters.plot_time_series.rst.txt b/docs/_sources/generated/cog_plot.plotters.plot_time_series.rst.txt
@@ -0,0 +1,6 @@
+cog\_plot.plotters.plot\_time\_series
+=====================================
+
+.. currentmodule:: cog_plot.plotters
+
+.. autofunction:: plot_time_series
diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -67,4 +67,7 @@ This research was supported by Templeton World Charity Foundation (`TWCF0389 <ht
    :maxdepth: 2
    :caption: Contents:
 
-   cog_plot
+   plot_matrix <generated/cog_plot.plotters.plot_matrix>
+   plot_rasters <generated/cog_plot.plotters.plot_rasters>
+   plot_time_series <generated/cog_plot.plotters.plot_time_series>
+   colors
diff --git a/docs/_sources/plotters.rst.txt b/docs/_sources/plotters.rst.txt
@@ -0,0 +1,14 @@
+Plotters Module
+===============
+
+.. automodule:: cog_plot.plotters
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+.. autosummary::
+   :toctree: generated/
+
+   plot_time_series
+   plot_matrix
+   plot_rasters