Skip to content

Commit 61c2cf8

Browse files
committed
update docs
1 parent d1f8be8 commit 61c2cf8

File tree

5 files changed

+40
-7
lines changed

5 files changed

+40
-7
lines changed

docs/index.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,20 @@
1-
Welcome to dmriprep's documentation!
2-
====================================
1+
..include:: links.rst
2+
..include:: ../README.rst
3+
../include:: license.rst
4+
5+
Contents
6+
--------
37

48
.. toctree::
59
:maxdepth: 2
610
:caption: Contents:
711

8-
readme
912
installation
1013
changes
1114
usage
1215
workflows
1316
outputs
1417
contributing
15-
authors
1618

1719
Indices and tables
1820
==================

docs/license.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
License information
2+
-------------------
3+
4+
We use the 3-clause BSD license; the full license may be found in the
5+
`LICENSE <https://github.com/josephmje/dmriprep/blob/master/LICENSE>`_ file
6+
in the ``dmriprep`` distribution.
7+
8+
All trademarks referenced herein are property of their respective holders.
9+
10+
Copyright (c) 2018-2019, the dMRIPrep.
11+
All rights reserved.

docs/readme.rst

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/usage.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. include:: links.rst
2+
13
Usage
24
-----
35

@@ -9,12 +11,31 @@ that is to be processed.
911
The input dataset is required to be in valid :abbr:`BIDS (Brain Imaging Data
1012
Structure)` format, and it must include at least one T1w structural image and
1113
a dwi series.
14+
15+
.. code-block:: console
16+
17+
bids
18+
└── sub-01
19+
├── anat
20+
│   └── sub-01_T1w.nii.gz
21+
├── dwi
22+
│   ├── sub-01_dwi.bval
23+
│   ├── sub-01_dwi.bvec
24+
│   ├── sub-01_dwi.json
25+
│   └── sub-01_dwi.nii.gz
26+
└── fmap
27+
├── sub-01_acq-dwi_dir-AP_epi.json
28+
├── sub-01_acq-dwi_dir-AP_epi.nii.gz
29+
├── sub-01_acq-dwi_dir-PA_epi.json
30+
└── sub-01_acq-dwi_dir-PA_epi.nii.gz
31+
1232
We highly recommend that you validate your dataset with the free, online
1333
`BIDS Validator <http://bids-standard.github.io/bids-validator/>`_.
1434

1535
The exact command to run ``dmriprep`` depends on the Installation_ method.
1636
The common parts of the command follow the `BIDS-Apps
1737
<https://github.com/BIDS-Apps>`_ definition.
38+
1839
Example: ::
1940

2041
dmriprep data/bids_root/ out/ participant -w work/

docs/workflows.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
Workflows
2-
=========
1+
Processing pipeline details
2+
===========================

0 commit comments

Comments
 (0)