Update documentation

neurodata · Apr 7, 2024 · e944602 · e944602
1 parent 47efcfb
commit e944602
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 20 deletions.
diff --git a/docs/pipeline/diffusion.rst → docs/diffusion.rst b/docs/pipeline/diffusion.rst → docs/diffusion.rst
diff --git a/docs/tutorials/funcref.rst → docs/funcref.rst b/docs/tutorials/funcref.rst → docs/funcref.rst
diff --git a/docs/pipeline/functional.rst → docs/functional.rst b/docs/pipeline/functional.rst → docs/functional.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,34 +1,30 @@
-.. m2g documentation master file, created by
-   sphinx-quickstart on Wed Dec 19 13:35:38 2018.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+..  -*- coding: utf-8 -*-
 
-.. _BiorXiv: https://www.biorxiv.org/content/early/2018/04/24/188706
+.. _contents:
 
-m2g
+.. _BiorXiv: https://doi.org/10.1101/2021.11.01.466686
+
+Overview of m2g
 ================================
 
-NeuroData’s MR Graphs package, m2g (pronounced “nutmeg”), is the successor of the MRCAP, MIGRAINE, and m2g pipelines. m2g combines dMRI and sMRI data from a single subject to estimate a high-level connectome reliably and scalably.
+NeuroData’s MR Graphs package, `m2g`, is the successor of the MRCAP, MIGRAINE, and m2g pipelines. m2g combines dMRI, fMRI, and sMRI data from a single subject to estimate a high-level connectome reliably and scalably.
 
 The m2g pipeline has been developed as a one-click solution for human connectome estimation by providing robust and reliable estimates of connectivity across a wide range of datasets. The pipelines are explained and derivatives analyzed in our pre-print, available on BiorXiv_.
 
-.. toctree::
-   :caption: Tutorials
-   :maxdepth: 3
+Free software
+-------------
 
-   tutorials/install
-   tutorials/funcref
+m2g is free software; you can redistribute it and/or modify it under the
+terms of the :doc:`Polyform </license>` license.  We welcome contributions.
+Join us on `GitHub <https://github.com/neurodata/m2g>`_.
 
 .. toctree::
-   :caption: Pipeline Overview
-   :maxdepth: 2
-
-   pipeline/diffusion
-   pipeline/functional
+   :caption: Documentation
+   :maxdepth: 3
 
-.. toctree::
-   :caption: Function Reference
-   :maxdepth: 1
+   install
+   diffusion
+   functional
 
 .. toctree::
    :maxdepth: 1
@@ -37,3 +33,4 @@ The m2g pipeline has been developed as a one-click solution for human connectome
    m2g @ GitHub <http://www.github.com/neurodata/m2g/>
    m2g @ PyPI <https://pypi.org/project/m2g/>
    Issue Tracker <https://github.com/neurodata/m2g/issues>
+   NeuroData Lab <http://neurodata.io/>
diff --git a/docs/tutorials/install.rst → docs/install.rst b/docs/tutorials/install.rst → docs/install.rst