Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add video tutorial to docs and minor improvements #866

Merged
merged 6 commits into from
Jun 17, 2024
Merged

Add video tutorial to docs and minor improvements #866

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b33632a
Add video tutorial to docs and minor improvements
rly Jun 17, 2024
4f99787
Fix circular reference issue in tutorials/index
rly Jun 17, 2024
732a1a6
Remove TOC from pages without
rly Jun 17, 2024
13cb122
Fix Markdown link to RST
rly Jun 17, 2024
c54257e
Hide toctree from main page
rly Jun 17, 2024
f6081d1
Merge branch 'main' into video_tutorial
CodyCBakerPhD Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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":
Expand Down
13 changes: 10 additions & 3 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.

Get started with NWB GUIDE by :doc:`installing it </installation>` on your computer and following the :doc:`tutorials </tutorials/index>` 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
Expand Down
2 changes: 1 addition & 1 deletion docs/installation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Download and run `NWB-GUIDE-x64.dmg <https://github.com/NeurodataWithoutBorders/
MacOS - Apple Silicon
---------------------

This installation applies to [current-generation Apple computers (M1-M4+)](https://support.apple.com/en-us/116943).
This installation applies to `current-generation Apple computers (M1-M4+) <https://support.apple.com/en-us/116943>`_.

Download and run `NWB-GUIDE-arm64.dmg <https://github.com/NeurodataWithoutBorders/nwb-guide/releases/latest/download/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.

Expand Down
6 changes: 6 additions & 0 deletions docs/tutorials/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 </installation>` as we detail the conversion process from initial setup to final upload.

.. note::
Watch a video walkthrough of these tutorials `here <https://www.youtube.com/watch?v=EhhdDVuHAZ0>`_.

.. note::
This tutorial focuses on uploading to the DANDI Development server.

Expand All @@ -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
Expand Down
Loading