test copy doc

ncc-brain · Sep 2, 2024 · 4fb79a5 · 4fb79a5
1 parent 77feeeb
commit 4fb79a5
Show file tree

Hide file tree

Showing 71 changed files with 28 additions and 45 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
diff --git a/docs/Makefile → Makefile b/docs/Makefile → Makefile
@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = .
-BUILDDIR      = _build
+SOURCEDIR     = source
+BUILDDIR      = build
 
 # Put it first so that "make" without argument is like "make help".
 help:

diff --git a/docs/_build/html/.buildinfo → doc/.buildinfo b/docs/_build/html/.buildinfo → doc/.buildinfo
diff --git a/docs/_build/html/_sources/index.rst.txt → doc/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt → doc/_sources/index.rst.txt
@@ -13,7 +13,7 @@ Installation
 ============
 
 To install PyNeon, clone the PyNeon repository from
-https://github.com/NCCLabMPI/pyneon and run:
+https://github.com/NCCLabMPI/PyNeon and run:
 
 .. code-block:: bash
 
@@ -24,7 +24,9 @@ PyPI and conda releases are planned for the future.
 Data format
 ===========
 
-PyNeon works with the "Timeseries" data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings.
+PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" formats 
+as exported from Pupil Clouds. The data could be from a single recording or from a 
+project with multiple recordings.
 
 .. toctree::
    :maxdepth: 1

diff --git a/...d/html/_sources/reference/dataset.rst.txt → doc/_sources/reference/dataset.rst.txt b/...d/html/_sources/reference/dataset.rst.txt → doc/_sources/reference/dataset.rst.txt
diff --git a/...ild/html/_sources/reference/index.rst.txt → doc/_sources/reference/index.rst.txt b/...ild/html/_sources/reference/index.rst.txt → doc/_sources/reference/index.rst.txt
diff --git a/...tml/_sources/reference/preprocess.rst.txt → doc/_sources/reference/preprocess.rst.txt b/...tml/_sources/reference/preprocess.rst.txt → doc/_sources/reference/preprocess.rst.txt
diff --git a/...html/_sources/reference/recording.rst.txt → doc/_sources/reference/recording.rst.txt b/...html/_sources/reference/recording.rst.txt → doc/_sources/reference/recording.rst.txt
diff --git a/...ild/html/_sources/tutorials/index.rst.txt → doc/_sources/tutorials/index.rst.txt b/...ild/html/_sources/tutorials/index.rst.txt → doc/_sources/tutorials/index.rst.txt
diff --git a/docs/_build/html/_static/basic.css → doc/_static/basic.css b/docs/_build/html/_static/basic.css → doc/_static/basic.css
diff --git a/docs/_build/html/_static/doctools.js → doc/_static/doctools.js b/docs/_build/html/_static/doctools.js → doc/_static/doctools.js
diff --git a/...ild/html/_static/documentation_options.js → doc/_static/documentation_options.js b/...ild/html/_static/documentation_options.js → doc/_static/documentation_options.js
diff --git a/docs/_build/html/_static/file.png → doc/_static/file.png b/docs/_build/html/_static/file.png → doc/_static/file.png
diff --git a/docs/_build/html/_static/language_data.js → doc/_static/language_data.js b/docs/_build/html/_static/language_data.js → doc/_static/language_data.js
diff --git a/docs/_build/html/_static/minus.png → doc/_static/minus.png b/docs/_build/html/_static/minus.png → doc/_static/minus.png
diff --git a/docs/_build/html/_static/plus.png → doc/_static/plus.png b/docs/_build/html/_static/plus.png → doc/_static/plus.png
diff --git a/docs/_build/html/_static/pygments.css → doc/_static/pygments.css b/docs/_build/html/_static/pygments.css → doc/_static/pygments.css
diff --git a/.../_build/html/_static/scripts/bootstrap.js → doc/_static/scripts/bootstrap.js b/.../_build/html/_static/scripts/bootstrap.js → doc/_static/scripts/bootstrap.js
diff --git a/.../_static/scripts/bootstrap.js.LICENSE.txt → doc/_static/scripts/bootstrap.js.LICENSE.txt b/.../_static/scripts/bootstrap.js.LICENSE.txt → doc/_static/scripts/bootstrap.js.LICENSE.txt
diff --git a/...ild/html/_static/scripts/bootstrap.js.map → doc/_static/scripts/bootstrap.js.map b/...ild/html/_static/scripts/bootstrap.js.map → doc/_static/scripts/bootstrap.js.map
diff --git a/...ml/_static/scripts/pydata-sphinx-theme.js → doc/_static/scripts/pydata-sphinx-theme.js b/...ml/_static/scripts/pydata-sphinx-theme.js → doc/_static/scripts/pydata-sphinx-theme.js
diff --git a/...static/scripts/pydata-sphinx-theme.js.map → ...static/scripts/pydata-sphinx-theme.js.map b/...static/scripts/pydata-sphinx-theme.js.map → ...static/scripts/pydata-sphinx-theme.js.map
diff --git a/docs/_build/html/_static/searchtools.js → doc/_static/searchtools.js b/docs/_build/html/_static/searchtools.js → doc/_static/searchtools.js
diff --git a/docs/_build/html/_static/sphinx_highlight.js → doc/_static/sphinx_highlight.js b/docs/_build/html/_static/sphinx_highlight.js → doc/_static/sphinx_highlight.js
diff --git a/.../_build/html/_static/styles/bootstrap.css → doc/_static/styles/bootstrap.css b/.../_build/html/_static/styles/bootstrap.css → doc/_static/styles/bootstrap.css
diff --git a/...ild/html/_static/styles/bootstrap.css.map → doc/_static/styles/bootstrap.css.map b/...ild/html/_static/styles/bootstrap.css.map → doc/_static/styles/bootstrap.css.map
diff --git a/...ml/_static/styles/pydata-sphinx-theme.css → doc/_static/styles/pydata-sphinx-theme.css b/...ml/_static/styles/pydata-sphinx-theme.css → doc/_static/styles/pydata-sphinx-theme.css
diff --git a/...static/styles/pydata-sphinx-theme.css.map → ...static/styles/pydata-sphinx-theme.css.map b/...static/styles/pydata-sphinx-theme.css.map → ...static/styles/pydata-sphinx-theme.css.map
diff --git a/docs/_build/html/_static/styles/theme.css → doc/_static/styles/theme.css b/docs/_build/html/_static/styles/theme.css → doc/_static/styles/theme.css
diff --git a/...atic/vendor/fontawesome/6.5.2/LICENSE.txt → ...atic/vendor/fontawesome/6.5.2/LICENSE.txt b/...atic/vendor/fontawesome/6.5.2/LICENSE.txt → ...atic/vendor/fontawesome/6.5.2/LICENSE.txt
diff --git a/.../vendor/fontawesome/6.5.2/css/all.min.css → .../vendor/fontawesome/6.5.2/css/all.min.css b/.../vendor/fontawesome/6.5.2/css/all.min.css → .../vendor/fontawesome/6.5.2/css/all.min.css
diff --git a/...ic/vendor/fontawesome/6.5.2/js/all.min.js → ...ic/vendor/fontawesome/6.5.2/js/all.min.js b/...ic/vendor/fontawesome/6.5.2/js/all.min.js → ...ic/vendor/fontawesome/6.5.2/js/all.min.js
diff --git a/...ntawesome/6.5.2/js/all.min.js.LICENSE.txt → ...ntawesome/6.5.2/js/all.min.js.LICENSE.txt b/...ntawesome/6.5.2/js/all.min.js.LICENSE.txt → ...ntawesome/6.5.2/js/all.min.js.LICENSE.txt
diff --git a/...tawesome/6.5.2/webfonts/fa-brands-400.ttf → ...tawesome/6.5.2/webfonts/fa-brands-400.ttf b/...tawesome/6.5.2/webfonts/fa-brands-400.ttf → ...tawesome/6.5.2/webfonts/fa-brands-400.ttf
diff --git a/...wesome/6.5.2/webfonts/fa-brands-400.woff2 → ...wesome/6.5.2/webfonts/fa-brands-400.woff2 b/...wesome/6.5.2/webfonts/fa-brands-400.woff2 → ...wesome/6.5.2/webfonts/fa-brands-400.woff2
diff --git a/...awesome/6.5.2/webfonts/fa-regular-400.ttf → ...awesome/6.5.2/webfonts/fa-regular-400.ttf b/...awesome/6.5.2/webfonts/fa-regular-400.ttf → ...awesome/6.5.2/webfonts/fa-regular-400.ttf
diff --git a/...esome/6.5.2/webfonts/fa-regular-400.woff2 → ...esome/6.5.2/webfonts/fa-regular-400.woff2 b/...esome/6.5.2/webfonts/fa-regular-400.woff2 → ...esome/6.5.2/webfonts/fa-regular-400.woff2
diff --git a/...ntawesome/6.5.2/webfonts/fa-solid-900.ttf → ...ntawesome/6.5.2/webfonts/fa-solid-900.ttf b/...ntawesome/6.5.2/webfonts/fa-solid-900.ttf → ...ntawesome/6.5.2/webfonts/fa-solid-900.ttf
diff --git a/...awesome/6.5.2/webfonts/fa-solid-900.woff2 → ...awesome/6.5.2/webfonts/fa-solid-900.woff2 b/...awesome/6.5.2/webfonts/fa-solid-900.woff2 → ...awesome/6.5.2/webfonts/fa-solid-900.woff2
diff --git a/...ome/6.5.2/webfonts/fa-v4compatibility.ttf → ...ome/6.5.2/webfonts/fa-v4compatibility.ttf b/...ome/6.5.2/webfonts/fa-v4compatibility.ttf → ...ome/6.5.2/webfonts/fa-v4compatibility.ttf
diff --git a/...e/6.5.2/webfonts/fa-v4compatibility.woff2 → ...e/6.5.2/webfonts/fa-v4compatibility.woff2 b/...e/6.5.2/webfonts/fa-v4compatibility.woff2 → ...e/6.5.2/webfonts/fa-v4compatibility.woff2
diff --git a/docs/_build/html/_static/webpack-macros.html → doc/_static/webpack-macros.html b/docs/_build/html/_static/webpack-macros.html → doc/_static/webpack-macros.html
diff --git a/docs/_build/html/genindex.html → doc/genindex.html b/docs/_build/html/genindex.html → doc/genindex.html
diff --git a/docs/_build/html/index.html → doc/index.html b/docs/_build/html/index.html → doc/index.html
@@ -329,15 +329,17 @@
 <section id="installation">
 <h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">#</a></h1>
 <p>To install PyNeon, clone the PyNeon repository from
-<a class="github reference external" href="https://github.com/NCCLabMPI/pyneon">NCCLabMPI/pyneon</a> and run:</p>
+<a class="github reference external" href="https://github.com/NCCLabMPI/PyNeon">NCCLabMPI/PyNeon</a> and run:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>.
 </pre></div>
 </div>
 <p>PyPI and conda releases are planned for the future.</p>
 </section>
 <section id="data-format">
 <h1>Data format<a class="headerlink" href="#data-format" title="Link to this heading">#</a></h1>
-<p>PyNeon works with the “Timeseries” data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings.</p>
+<p>PyNeon works with the “Timeseries Data” or “Timeseries Data + Scene Video” formats
+as exported from Pupil Clouds. The data could be from a single recording or from a
+project with multiple recordings.</p>
 <div class="toctree-wrapper compound">
 </div>
 </section>

diff --git a/docs/_build/html/objects.inv → doc/objects.inv b/docs/_build/html/objects.inv → doc/objects.inv
diff --git a/docs/_build/html/py-modindex.html → doc/py-modindex.html b/docs/_build/html/py-modindex.html → doc/py-modindex.html
diff --git a/docs/_build/html/reference/dataset.html → doc/reference/dataset.html b/docs/_build/html/reference/dataset.html → doc/reference/dataset.html
diff --git a/docs/_build/html/reference/index.html → doc/reference/index.html b/docs/_build/html/reference/index.html → doc/reference/index.html
diff --git a/docs/_build/html/reference/preprocess.html → doc/reference/preprocess.html b/docs/_build/html/reference/preprocess.html → doc/reference/preprocess.html
diff --git a/docs/_build/html/reference/recording.html → doc/reference/recording.html b/docs/_build/html/reference/recording.html → doc/reference/recording.html
@@ -412,6 +412,12 @@ <h1>pyneon.NeonRecording<a class="headerlink" href="#pyneon-neonrecording" title
 <li><p><strong>resamp_other_kind</strong> (<em>str</em><em>, </em><em>optional</em>) – Resampling method for columns of other types, by default “nearest”.</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>concat_data</strong> – Concatenated data.</p>
+</dd>
+<dt class="field-odd">Return type<span class="colon">:</span></dt>
+<dd class="field-odd"><p>pd.DataFrame</p>
+</dd>
 </dl>
 </dd></dl>
 

diff --git a/docs/_build/html/search.html → doc/search.html b/docs/_build/html/search.html → doc/search.html
diff --git a/doc/searchindex.js b/doc/searchindex.js
diff --git a/docs/_build/html/tutorials/index.html → doc/tutorials/index.html b/docs/_build/html/tutorials/index.html → doc/tutorials/index.html
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/reference/dataset.doctree b/docs/_build/doctrees/reference/dataset.doctree
diff --git a/docs/_build/doctrees/reference/index.doctree b/docs/_build/doctrees/reference/index.doctree
diff --git a/docs/_build/doctrees/reference/preprocess.doctree b/docs/_build/doctrees/reference/preprocess.doctree
diff --git a/docs/_build/doctrees/reference/recording.doctree b/docs/_build/doctrees/reference/recording.doctree
diff --git a/docs/_build/doctrees/tutorials/index.doctree b/docs/_build/doctrees/tutorials/index.doctree
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/make.bat → make.bat b/docs/make.bat → make.bat
@@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
-set SOURCEDIR=.
-set BUILDDIR=_build
+set SOURCEDIR=source
+set BUILDDIR=build
 
 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (

diff --git a/pyneon/recording.py b/pyneon/recording.py
@@ -164,5 +164,10 @@ def concat_channels(
             Resampling method for columns of float type, by default "linear".   
         resamp_other_kind : str, optional
             Resampling method for columns of other types, by default "nearest".
+        
+        Returns
+        -------
+        concat_data : pd.DataFrame
+            Concatenated data.
         """
         return concat_channels(self, ch_names, resamp_float_kind, resamp_other_kind)
diff --git a/docs/conf.py → source/conf.py b/docs/conf.py → source/conf.py
diff --git a/docs/index.rst → source/index.rst b/docs/index.rst → source/index.rst
@@ -13,7 +13,7 @@ Installation
 ============
 
 To install PyNeon, clone the PyNeon repository from
-https://github.com/NCCLabMPI/pyneon and run:
+https://github.com/NCCLabMPI/PyNeon and run:
 
 .. code-block:: bash
 
@@ -24,7 +24,9 @@ PyPI and conda releases are planned for the future.
 Data format
 ===========
 
-PyNeon works with the "Timeseries" data format as exported from Pupil Clouds. The data could be from a single recording or from a project with multiple recordings.
+PyNeon works with the "Timeseries Data" or "Timeseries Data + Scene Video" formats 
+as exported from Pupil Clouds. The data could be from a single recording or from a 
+project with multiple recordings.
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/reference/dataset.rst → source/reference/dataset.rst b/docs/reference/dataset.rst → source/reference/dataset.rst
diff --git a/docs/reference/index.rst → source/reference/index.rst b/docs/reference/index.rst → source/reference/index.rst
diff --git a/docs/reference/preprocess.rst → source/reference/preprocess.rst b/docs/reference/preprocess.rst → source/reference/preprocess.rst
diff --git a/docs/reference/recording.rst → source/reference/recording.rst b/docs/reference/recording.rst → source/reference/recording.rst
diff --git a/docs/tutorials/index.rst → source/tutorials/index.rst b/docs/tutorials/index.rst → source/tutorials/index.rst