From db2ea572a1f5f95d9384a2e50330ed0c41be6473 Mon Sep 17 00:00:00 2001 From: Ryan Ly Date: Mon, 23 Dec 2024 13:48:49 -0800 Subject: [PATCH] Fix matnwb doc links --- docs/source/conf_extlinks.py | 2 +- docs/source/conversion_tutorial/03_nwb_apis.rst | 8 ++++---- docs/source/core_tools/core_tools_home.rst | 2 +- docs/source/file_read/file_read.rst | 2 +- docs/source/file_read/matnwb/dynamictable.rst | 2 +- docs/source/file_read/matnwb/untyped.rst | 2 +- docs/source/intro_to_nwb/4_apis.rst | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/conf_extlinks.py b/docs/source/conf_extlinks.py index e80a135..a1c732d 100644 --- a/docs/source/conf_extlinks.py +++ b/docs/source/conf_extlinks.py @@ -14,7 +14,7 @@ 'hdmf-src': ('https://github.com/hdmf-dev/hdmf/%s', '%s'), 'hdmf-specification-language': ('https://hdmf-schema-language.readthedocs.io/en/latest/%s', '%s'), 'matnwb-src': ('https://github.com/NeurodataWithoutBorders/matnwb/%s', '%s'), - 'matnwb-docs': ('https://neurodatawithoutborders.github.io/matnwb/%s', '%s'), + 'matnwb-docs': ('https://matnwb.readthedocs.io/en/latest/%s', '%s'), 'neuroconv-docs': ('https://neuroconv.readthedocs.io/en/main/%s', '%s'), 'neuroconv-src': ('https://github.com/catalystneuro/neuroconv/%s', '%s'), 'nwbinspector-docs': ('https://nwbinspector.readthedocs.io/en/dev/%s', '%s'), diff --git a/docs/source/conversion_tutorial/03_nwb_apis.rst b/docs/source/conversion_tutorial/03_nwb_apis.rst index 712f8e9..19b31b9 100644 --- a/docs/source/conversion_tutorial/03_nwb_apis.rst +++ b/docs/source/conversion_tutorial/03_nwb_apis.rst @@ -29,24 +29,24 @@ modality: `23 min video `__ - - `tutorial `__ + - `tutorial `__ `46 min video `__ * - Writing intracellular electrophysiology - `tutorial `__ - - `tutorial `__ + - `tutorial `__ * - Writing calcium imaging - `tutorial `__ `31 min video `__ - - `tutorial `__ + - `tutorial `__ `39 min video `__ * - Advanced I/O - `tutorials `__ `26 min video `__ - - `tutorial `__ + - `tutorial `__ `16 min video `__ diff --git a/docs/source/core_tools/core_tools_home.rst b/docs/source/core_tools/core_tools_home.rst index 4720ee6..2989425 100644 --- a/docs/source/core_tools/core_tools_home.rst +++ b/docs/source/core_tools/core_tools_home.rst @@ -31,7 +31,7 @@ The NWB reference APIs provide full support for reading and writing all componen :class: align-left, no-scaled-link :width: 100 -:matnwb-docs:`MatNWB <>` is a MATLAB library for reading and writing NWB files. :bdg-link-primary:`Docs ` :bdg-link-primary:`Tutorials ` :bdg-link-primary:`Source ` +:matnwb-docs:`MatNWB <>` is a MATLAB library for reading and writing NWB files. :bdg-link-primary:`Docs ` :bdg-link-primary:`Tutorials ` :bdg-link-primary:`Source ` .. raw:: html diff --git a/docs/source/file_read/file_read.rst b/docs/source/file_read/file_read.rst index 1b8ee18..92657f4 100644 --- a/docs/source/file_read/file_read.rst +++ b/docs/source/file_read/file_read.rst @@ -3,7 +3,7 @@ Reading NWB Files ================== -This section provides an introduction on how to read NWB files in Python using PyNWB and Matlab using MatNWB. If you are interested in converting your data to NWB, then please see the :neuroconv-docs:`NeuroConv User Guide ` as well as for more in-depth tutorials visit the :pynwb-docs:`PyNWB ` and :matnwb-docs:`MatNWB <#tutorials>` tutorials and documentation. +This section provides an introduction on how to read NWB files in Python using PyNWB and Matlab using MatNWB. If you are interested in converting your data to NWB, then please see the :neuroconv-docs:`NeuroConv User Guide ` as well as for more in-depth tutorials visit the :pynwb-docs:`PyNWB ` and :matnwb-docs:`MatNWB ` tutorials and documentation. Reading With PyNWB ~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/file_read/matnwb/dynamictable.rst b/docs/source/file_read/matnwb/dynamictable.rst index d811126..2f1fda1 100644 --- a/docs/source/file_read/matnwb/dynamictable.rst +++ b/docs/source/file_read/matnwb/dynamictable.rst @@ -34,4 +34,4 @@ Finally, if you prefer to select using your custom ``id`` column, you can specif tableData = dynamicTable.getRow(, 'useId', true); -For more information regarding Dynamic Tables in MatNWB as well as information regarding writing data to them, please see the `MatNWB DynamicTables Tutorial `_. +For more information regarding Dynamic Tables in MatNWB as well as information regarding writing data to them, please see the `MatNWB DynamicTables Tutorial `_. diff --git a/docs/source/file_read/matnwb/untyped.rst b/docs/source/file_read/matnwb/untyped.rst index 2cfc439..40ebade 100644 --- a/docs/source/file_read/matnwb/untyped.rst +++ b/docs/source/file_read/matnwb/untyped.rst @@ -35,7 +35,7 @@ DataStubs and DataPipes .. image:: /img/matnwb_datastub.png -**DataPipes** are similar to DataStubs in that they allow you to load data from disk; however, they also provide a wide array of features that allow the user to write data to disk, either by streaming parts of data in at a time or by compressing the data before writing. The DataPipe is an advanced type and users looking to leverage DataPipe's capabilities to stream/iteratively write or compress data should read the `Advanced Data Write Tutorial `_. +**DataPipes** are similar to DataStubs in that they allow you to load data from disk; however, they also provide a wide array of features that allow the user to write data to disk, either by streaming parts of data in at a time or by compressing the data before writing. The DataPipe is an advanced type and users looking to leverage DataPipe's capabilities to stream/iteratively write or compress data should read the `Advanced Data Write Tutorial `_. .. _matnwb-read-untyped-links-views: diff --git a/docs/source/intro_to_nwb/4_apis.rst b/docs/source/intro_to_nwb/4_apis.rst index 7a311ae..f0c1331 100644 --- a/docs/source/intro_to_nwb/4_apis.rst +++ b/docs/source/intro_to_nwb/4_apis.rst @@ -45,7 +45,7 @@ researchers and developers interested in using NWB and in learning more about th A growing collection of :ref:`analysistools-home` (gray) developed by the neurophysiology community along with a broad range of :ref:`core tools ` (red) help users with conversion, extension, validation and use of -NWB data files. Commonly, these tools build on the :pynwb-docs:`PyNWB (Python) <>` and :matnwb-docs:`MatNWB (Matlab) <>` +NWB data files. Commonly, these tools build on the :pynwb-docs:`PyNWB (Python) <>` and :matnwb-docs:`MatNWB (MATLAB) <>` reference APIs (lilac) to read and write NWB files. Each of the APIs and tools provides their own in-depth tutorials and documentation to help guide users in adopting and using the software.