final touches on documentation and style for v0.1.0

NeLy-EPFL · Sep 11, 2021 · 6fa36a7 · 6fa36a7
1 parent 05ef5e7
commit 6fa36a7
Show file tree

Hide file tree

Showing 44 changed files with 1,764 additions and 12,767 deletions.
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -1,17 +1,20 @@
 
 <!DOCTYPE html>
 
-<html xmlns="http://www.w3.org/1999/xhtml">
+<html>
   <head>
     <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Overview: module code &#8212; utils2p  documentation</title>
-    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
+    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
+    <link rel="stylesheet" type="text/css" href="../_static/alabaster.css" />
+    <link rel="stylesheet" href="../_static/css/functions.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/css/methods.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/css/classes.css" type="text/css" />
+    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
     <script src="../_static/jquery.js"></script>
     <script src="../_static/underscore.js"></script>
     <script src="../_static/doctools.js"></script>
-    <script src="../_static/language_data.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
 
@@ -51,7 +54,7 @@ <h1 class="logo"><a href="../index.html">utils2p</a></h1>
 
 
 <h3>Navigation</h3>
-<p class="caption"><span class="caption-text">Contents:</span></p>
+<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../main.html">Core functions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="../synchronization.html">Synchronization functions</a></li>
@@ -69,7 +72,7 @@ <h3>Related Topics</h3>
   <h3 id="searchlabel">Quick search</h3>
     <div class="searchformwrapper">
     <form class="search" action="../search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
@@ -91,7 +94,7 @@ <h3 id="searchlabel">Quick search</h3>
       &copy;2020, Florian Aymanns.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.1.2</a>
       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
 
     </div>

diff --git a/docs/build/html/_modules/utils2p/main.html b/docs/build/html/_modules/utils2p/main.html
diff --git a/docs/build/html/_modules/utils2p/synchronization.html b/docs/build/html/_modules/utils2p/synchronization.html
diff --git a/docs/build/html/_sources/loading_preprocessing.rst.txt b/docs/build/html/_sources/loading_preprocessing.rst.txt
@@ -1,9 +1,10 @@
 Loading and preprocessing
 =========================
 
-.. autofunction:: utils2p.synchronization.get_lines_from_h5_file
+.. autofunction:: utils2p.synchronization.get_lines_from_sync_file
 .. autofunction:: utils2p.synchronization.process_cam_line
 .. autofunction:: utils2p.synchronization.process_frame_counter
 .. autofunction:: utils2p.synchronization.process_optical_flow_line
 .. autofunction:: utils2p.synchronization.process_stimulus_line
 .. autofunction:: utils2p.synchronization.process_odor_line
+.. autofunction:: utils2p.synchronization.get_processed_lines
diff --git a/docs/build/html/_sources/misc_sync.rst.txt b/docs/build/html/_sources/misc_sync.rst.txt
@@ -8,3 +8,4 @@ Miscellaneous
 .. autofunction:: utils2p.synchronization.correct_split_edges
 .. autofunction:: utils2p.synchronization.epoch_length_filter
 .. autofunction:: utils2p.synchronization.event_based_frame_indices
+.. autoclass:: utils2p.synchronization.SyncMetadata