Merge pull request #146 from catalystneuro/some_documentation_warnings

Fix some links in the conversion gallery
catalystneuro · Sep 8, 2022 · 5081c18 · 5081c18
2 parents f0ffc25 + fbb0d22
commit 5081c18
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 15 deletions.
diff --git a/docs/api/interfaces.icephys.rst b/docs/api/interfaces.icephys.rst
@@ -1,5 +1,5 @@
 Intracellular electrophysiology
-===================
+===============================
 
 Base Interface
 --------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -5,18 +5,17 @@
 
 project = "NeuroConv"
 copyright = "2022, CatalystNeuro"
-author = "Cody Baker and Ben Dichter"
+author = "Cody Baker, Heberto Mayorquin, Szonja Weigl and Ben Dichter"
 
 extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "sphinx.ext.napoleon",
-    "myst_parser",
-    "sphinx_toggleprompt",
-    "sphinx_copybutton",
-    "sphinx.ext.intersphinx",
-    "sphinx_search.extension",
-    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",  # Support for NumPy and Google style docstrings
+    "sphinx.ext.autodoc",  # Includes documentation from docstrings in docs/api
+    "sphinx.ext.autosummary", # To-add
+    "sphinx_toggleprompt",  # Used to control >>> behavior in the conversion gallery example doctests
+    "sphinx_copybutton",  # Used to control the copy button behavior in the conversion gallery doctsts
+    "sphinx.ext.intersphinx",  # Allows links to other sphinx project documentation sites
+    "sphinx_search.extension",  # Allows for auto search function the documentation
+    "sphinx.ext.viewcode",  # Shows source code in the documentation
     "sphinx.ext.extlinks",  # Allows to use shorter external links defined in the extlinks variable.
 ]
 

diff --git a/docs/conversion_examples_gallery/imaging/tiff.rst b/docs/conversion_examples_gallery/imaging/tiff.rst
@@ -1,5 +1,5 @@
 TIFF data conversion
-^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^
 
 Install NeuroConv with the additional dependencies necessary for reading TIFF data.
 

diff --git a/docs/conversion_examples_gallery/recording/axona.rst b/docs/conversion_examples_gallery/recording/axona.rst
@@ -7,7 +7,7 @@ Install NeuroConv with the additional dependencies necessary for reading Axona d
 
     pip install neuroconv[axona]
 
-Convert axona data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.axona.axonadatainterface.AxonaRecordingExtractorInterface`.
+Convert axona data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.axona.axonadatainterface.AxonaRecordingInterface`.
 
 .. code-block:: python
 

diff --git a/docs/conversion_examples_gallery/recording/blackrock.rst b/docs/conversion_examples_gallery/recording/blackrock.rst
@@ -7,7 +7,7 @@ Install NeuroConv with the additional dependencies necessary for reading Blackro
 
     pip install neuroconv[blackrock]
 
-Convert Blackrock data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.blackrock.blackrockdatainterface.BlackrockRecordingExtractorInterface`.
+Convert Blackrock data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.blackrock.blackrockdatainterface.BlackrockRecordingInterface`.
 
 .. code-block:: python
 

diff --git a/docs/conversion_examples_gallery/recording/openephys.rst b/docs/conversion_examples_gallery/recording/openephys.rst
@@ -7,7 +7,7 @@ Install NeuroConv with the additional dependencies necessary for reading OpenEph
 
     pip install neuroconv[openephys]
 
-Convert OpenEphys data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.openephys.openephysdatainterface.OpenEphysRecordingExtractorInterface`.
+Convert OpenEphys data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.openephys.openephysdatainterface.OpenEphysRecordingInterface`.
 
 .. code-block:: python
 

diff --git a/docs/conversion_examples_gallery/sorting/blackrock.rst b/docs/conversion_examples_gallery/sorting/blackrock.rst
@@ -9,6 +9,7 @@ Install NeuroConv with the additional dependencies necessary for reading Blackro
 Convert Blackrock sorting data to NWB using :py:class:`~neuroconv.datainterfaces.ecephys.blackrock.blackrockdatainterface.BlackrockSortingInterface`.
 
 .. code-block:: python
+
     >>> from datetime import datetime
     >>> from dateutil import tz
     >>> from pathlib import Path