Skip to content

Commit aed7840

Browse files
mgxdmgxd
committed
DOC: Display API per module
1 parent 96250df commit aed7840

File tree

7 files changed

+76
-8
lines changed

7 files changed

+76
-8
lines changed

‎docs/_api/base.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
====
2+
Base
3+
====
4+
5+
.. automodule:: nitransforms.base
6+
:members:

‎docs/_api/io.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
===
2+
IO
3+
===
4+
5+
Reading and writing of transform files.
6+
7+
--------
8+
Base I/O
9+
--------
10+
.. automodule:: nitransforms.io.base
11+
:members:
12+
13+
-----------------
14+
Tool Specific I/O
15+
-----------------
16+
17+
^^^^
18+
AFNI
19+
^^^^
20+
.. automodule:: nitransforms.io.afni
21+
:members:
22+
23+
^^^
24+
FSL
25+
^^^
26+
.. automodule:: nitransforms.io.fsl
27+
:members:
28+
29+
^^^
30+
ITK
31+
^^^
32+
.. automodule:: nitransforms.io.itk
33+
:members:
34+
35+
^^^^^^^^^^^^^^
36+
FreeSurfer/LTA
37+
^^^^^^^^^^^^^^
38+
.. automodule:: nitransforms.io.lta
39+
:members:

‎docs/_api/linear.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=================
2+
Linear Transforms
3+
=================
4+
5+
.. automodule:: nitransforms.linear
6+
:members:

‎docs/_api/manip.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=============
2+
Manipulations
3+
=============
4+
5+
.. automodule:: nitransforms.manip
6+
:members:

‎docs/_api/nonlinear.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
====================
2+
Nonlinear Transforms
3+
====================
4+
5+
.. automodule:: nitransforms.nonlinear
6+
:members:

‎docs/_api/patched.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
=========================
2+
Patched Nibabel Functions
3+
=========================
4+
5+
.. automodule:: nitransforms.patched
6+
:members:

‎docs/api.rst

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,11 @@ Library API (application program interface)
33
Information on specific functions, classes, and methods for developers.
44

55
.. toctree::
6-
:glob:
6+
:maxdepth: 1
77

8-
api/nitransforms.base
9-
api/nitransforms.cli
10-
api/nitransforms.io
11-
api/nitransforms.linear
12-
api/nitransforms.manip
13-
api/nitransforms.nonlinear
14-
api/nitransforms.patched
8+
_api/base
9+
_api/io
10+
_api/linear
11+
_api/manip
12+
_api/nonlinear
13+
_api/patched

0 commit comments

Comments
 (0)