Skip to content

Commit de116d5

Browse files
committed
Add usage page.
1 parent 9375467 commit de116d5

4 files changed

Lines changed: 70 additions & 4 deletions

File tree

docs/index.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
# ModelArrayIO
2-
31
```{include} ../README.md
42
```
3+
4+
```{toctree}
5+
:maxdepth: 2
6+
:caption: Usage
7+
8+
usage
9+
```

docs/usage.rst

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
########################################
2+
Using ModelArrayIO from the command line
3+
########################################
4+
5+
6+
********
7+
confixel
8+
********
9+
10+
.. argparse::
11+
:ref: modelarrayio.fixels:get_parser
12+
:prog: confixel
13+
:func: get_parser
14+
15+
16+
********
17+
convoxel
18+
********
19+
20+
.. argparse::
21+
:ref: modelarrayio.voxels:get_parser
22+
:prog: convoxel
23+
:func: get_parser
24+
25+
26+
********
27+
concifti
28+
********
29+
30+
.. argparse::
31+
:ref: modelarrayio.cifti:get_parser
32+
:prog: concifti
33+
:func: get_parser
34+
35+
36+
****************
37+
fixelstats_write
38+
****************
39+
40+
.. argparse::
41+
:ref: modelarrayio.fixels:get_h5_to_fixels_parser
42+
:prog: fixelstats_write
43+
:func: get_h5_to_fixels_parser
44+
45+
*****************
46+
volumestats_write
47+
*****************
48+
49+
.. argparse::
50+
:ref: modelarrayio.voxels:get_h5_to_volume_parser
51+
:prog: volumestats_write
52+
:func: get_h5_to_volume_parser
53+
54+
55+
****************
56+
ciftistats_write
57+
****************
58+
59+
.. argparse::
60+
:ref: modelarrayio.cifti:get_h5_to_ciftis_parser
61+
:prog: ciftistats_write
62+
:func: get_h5_to_ciftis_parser

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ exclude = ".*"
103103

104104
[tool.ruff]
105105
line-length = 99
106-
src = ["src"]
106+
src = ["src/modelarrayio"]
107107

108108
[tool.ruff.lint]
109109
extend-select = [

src/modelarrayio/fixels.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,6 @@ def write_storage(
328328

329329

330330
def get_parser():
331-
332331
parser = argparse.ArgumentParser(description='Create a hdf5 file of fixel data')
333332
parser.add_argument('--index-file', '--index_file', help='Index File', required=True)
334333
parser.add_argument(

0 commit comments

Comments
 (0)