From 5623437b7849d6d5c5a29e852b1fc03cb60a5766 Mon Sep 17 00:00:00 2001 From: Jeffrey Gill Date: Fri, 18 Oct 2019 05:39:17 -0400 Subject: [PATCH] Add links to Neo's IO class list to docs --- README.rst | 8 +++++--- docs/index.rst | 7 ++++--- docs/metadata.rst | 3 ++- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 965cb06..6857ea4 100644 --- a/README.rst +++ b/README.rst @@ -9,9 +9,10 @@ Documentation_ | `Release Notes`_ | `Issue Tracker`_ **neurotic** is an app for Windows, macOS, and Linux that allows you to easily review and annotate your electrophysiology data and simultaneously captured -video. It is an easy way to load your Neo_-compatible data into ephyviewer_ -without doing any programming. Share a single metadata file with your -colleagues and they too will quickly be looking at the same datasets! +video. It is an easy way to load your Neo_-compatible data (see neo.io_ for +file formats) into ephyviewer_ without doing any programming. Share a single +metadata file with your colleagues and they too will quickly be looking at the +same datasets! To use the app, first organize your datasets in a *metadata file* like this (see `Configuring Metadata`_): @@ -212,6 +213,7 @@ The command line interface accepts other arguments too: .. _GitHub: https://github.com/jpgill86/neurotic .. _Issue Tracker: https://github.com/jpgill86/neurotic/issues .. _Neo: https://github.com/NeuralEnsemble/python-neo +.. _neo.io: https://neo.readthedocs.io/en/latest/io.html#module-neo.io .. _PyAV: https://docs.mikeboers.com/pyav/develop/installation.html .. _PyPI: https://pypi.org/project/neurotic .. _ReadTheDocs: https://readthedocs.org/projects/neurotic diff --git a/docs/index.rst b/docs/index.rst index 509e44a..73edec6 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,9 +9,10 @@ neurotic **neurotic** is an app for Windows, macOS, and Linux that allows you to easily review and annotate your electrophysiology data and simultaneously captured -video. It is an easy way to load your Neo_-compatible data into ephyviewer_ -without doing any programming. Share a single metadata file with your -colleagues and they too will quickly be looking at the same datasets! +video. It is an easy way to load your Neo_-compatible data (see :mod:`neo.io` +for file formats) into ephyviewer_ without doing any programming. Share a +single metadata file with your colleagues and they too will quickly be looking +at the same datasets! |Example screenshot| diff --git a/docs/metadata.rst b/docs/metadata.rst index 84ab50b..9638905 100644 --- a/docs/metadata.rst +++ b/docs/metadata.rst @@ -62,7 +62,8 @@ flat (no subdirectories), these should be simply the file names. Only ====================== ======================================================== Key Description ====================== ======================================================== -``data_file`` A single Neo_-compatible data file (required) +``data_file`` A single Neo_-compatible data file (see :mod:`neo.io` + for file formats) ``video_file`` A video file that can be synchronized with ``data_file`` ``annotations_file`` A CSV file for read-only annotations ``epoch_encoder_file`` A CSV file for annotations writable by the epoch encoder