Skip to content

Commit

Permalink
Update main page and add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ehennestad committed Dec 6, 2024
1 parent d913c6b commit 3cb5a33
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 10 deletions.
16 changes: 16 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ def setup(app):
'sphinx.ext.autodoc', # autogenerate docs
'sphinx.ext.napoleon', # for parsing e.g google style parameter docstring
'sphinx.ext.viewcode',
'sphinx.ext.extlinks', # For maintaining external links
'sphinx_copybutton',
]

Expand Down Expand Up @@ -67,3 +68,18 @@ def setup(app):
html_css_files = [
'css/custom.css',
]


# External links used in the documentation
extlinks = {
'incf_lesson': ('https://training.incf.org/lesson/%s', '%s'),
'incf_collection': ('https://training.incf.org/collection/%s', '%s'),
'nwb_extension': ('https://github.com/nwb-extensions/%s', '%s'),
'pynwb': ('https://github.com/NeurodataWithoutBorders/pynwb/%s', '%s'),
'nwb_overview': ('https://nwb-overview.readthedocs.io/en/latest/%s', '%s'),
'hdmf-docs': ('https://hdmf.readthedocs.io/en/stable/%s', '%s'),
'dandi': ('https://www.dandiarchive.org/%s', '%s'),
"nwbinspector": ("https://nwbinspector.readthedocs.io/en/dev/%s", "%s"),
'hdmf-zarr': ('https://hdmf-zarr.readthedocs.io/en/latest/%s', '%s'),
'matlab-online-tutorial': ('https://matlab.mathworks.com/open/github/v1?repo=NeurodataWithoutBorders/matnwb&file=tutorials/%s.mlx', '%s')
}
20 changes: 14 additions & 6 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
MatNWB documentation
====================
##############
NWB for MATLAB
##############

Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
documentation for details.
MatNWB is a MATLAB package for working with NWB files. It provides a high-level
API for efficiently working with neurodata stored in the NWB format. If you are
new to NWB and would like to learn more, then please also visit the
:nwb_overview:`NWB Overview <>` website, which provides an entry point for
researchers and developers interested in using NWB.


********
Contents
********

.. toctree::
:maxdepth: 2
:caption: Getting Started

pages/install_users
pages/installation_users
pages/tutorials/index
pages/overview_citing

Expand Down
4 changes: 0 additions & 4 deletions docs/source/pages/install_users.rst

This file was deleted.

21 changes: 21 additions & 0 deletions docs/source/pages/installation_users.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Install MatNWB
==============

Download the current release of MatNWB from the
`MatNWB releases page <https://github.com/NeurodataWithoutBorders/matnwb/releases>`_
or from the `MATLAB's FileExchange <https://www.mathworks.com/matlabcentral/fileexchange/67741-neurodatawithoutborders-matnwb>`_.
You can also check out the latest development version via::

git clone https://github.com/NeurodataWithoutBorders/matnwb.git

After downloading MatNWB, make sure to add it to MATLAB's search path:

.. code-block:: matlab
addpath("path/to/matnwb")
savepath() % Permanently add to search path
Requirements
------------

MATLAB R2016 or later?

0 comments on commit 3cb5a33

Please sign in to comment.