Skip to content

Commit ec068f2

Browse files
committed
add docs requirements for readthedocs install
1 parent 048efd1 commit ec068f2

File tree

3 files changed

+27
-10
lines changed

3 files changed

+27
-10
lines changed

.readthedocs.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
python:
2+
install:
3+
- method: pip
4+
path: .
5+
extra_requirements:
6+
- doc

docs/conf.py

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,8 @@
3737
extensions = [
3838
"sphinx.ext.autodoc",
3939
"sphinx.ext.viewcode",
40-
"sphinx_click.ext"
40+
"sphinx.ext.napoleon",
41+
"sphinx_click.ext",
4142
]
4243

4344
# Add any paths that contain templates here, relative to this directory.
@@ -132,13 +133,7 @@
132133
# (source start file, target name, title, author, documentclass
133134
# [howto, manual, or own class]).
134135
latex_documents = [
135-
(
136-
master_doc,
137-
"dmriprep.tex",
138-
"dmriprep Documentation",
139-
author,
140-
"manual",
141-
)
136+
(master_doc, "dmriprep.tex", "dmriprep Documentation", author, "manual")
142137
]
143138

144139

docs/outputs.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,18 @@
1-
Outputs
2-
=======
1+
Outputs of dMRIPrep
2+
===================
3+
4+
dMRIPrep generates:
5+
6+
1. **Visual QA (quality assurance) reports**
7+
8+
2. **Pre-processed imaging data**
9+
10+
Visual Reports
11+
--------------
12+
13+
Preprocessed data (dMRIPrep *derivatives*)
14+
------------------------------------------
15+
16+
Anatomical derivatives are placed in each subject's ``anat`` subfolder:
17+
18+
Diffusion derivatives are stored in the ``dwi`` subfolder.

0 commit comments

Comments
 (0)