diff --git a/docs/conf.py b/docs/conf.py index bb176979b..e479444b8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -135,6 +135,15 @@ "doc_path": "docs", } +# Workaround for removing the left sidebar on pages without TOC +# A better solution would be to follow the merge of: +# https://github.com/pydata/pydata-sphinx-theme/pull/1682 +html_sidebars = { + "installation": [], + "format_support": [], + "developer_guide": [], +} + def _correct_signatures(app, what, name, obj, options, signature, return_annotation): if what == "class": diff --git a/docs/index.rst b/docs/index.rst index 2805f6417..771d8b94d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,12 +10,19 @@ NWB GUIDE documentation | -The **NWB Graphical User Interface for Data Entry (GUIDE)** is an Electron-based application designed to help you navigate -the complex process of converting data from common proprietary formats into the :nwb-overview:`Neurodata Without Borders (NWB) <>` standard. +The **NWB Graphical User Interface for Data Entry (GUIDE)** is a cross-platform desktop application that walks neuroscientists +through the requirements of converting their data from common proprietary formats to the :nwb-overview:`Neurodata Without Borders (NWB) <>` standard +and uploading data to the :dandi-archive:`DANDI Archive <>`. -The resulting files are fully compliant with the best practices expected by the :dandi-archive:`Distributed Archives for Neurophysiology Data Integration (DANDI) <>`. +.. note:: + Watch a tutorial video of NWB GUIDE `here `_. + +Get started with NWB GUIDE by :doc:`installing it ` on your computer and following the :doc:`tutorials ` in this documentation. + +.. The TOC below is hidden from the main page contents but needed to generate the top menu .. toctree:: + :hidden: :maxdepth: 2 installation diff --git a/docs/installation.rst b/docs/installation.rst index 75b5e98df..78d430f2e 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -17,7 +17,7 @@ Download and run `NWB-GUIDE-x64.dmg `_. Download and run `NWB-GUIDE-arm64.dmg `_. This will prompt you to move the app into your 'Applications' folder. Then open the 'NWB GUIDE' app from your 'Applications' folder. diff --git a/docs/tutorials/index.rst b/docs/tutorials/index.rst index 7ad376d9b..d8e9d0302 100644 --- a/docs/tutorials/index.rst +++ b/docs/tutorials/index.rst @@ -5,6 +5,9 @@ to the Neurodata Without Borders (NWB) format and uploading to the DANDI Archive In these tutorials, you'll follow along on a :doc:`local installation of the GUIDE ` as we detail the conversion process from initial setup to final upload. +.. note:: + Watch a video walkthrough of these tutorials `here `_. + .. note:: This tutorial focuses on uploading to the DANDI Development server. @@ -21,7 +24,10 @@ In these tutorials, you'll follow along on a :doc:`local installation of the GUI Before you begin these tutorials, **you'll need to generate the tutorial dataset** using the instructions on the Dataset page. +.. toctree:: + :hidden: + self .. toctree:: :maxdepth: 2