Skip to content

Commit d118808

Browse files
committed
DOC: docs
1 parent f9f2a3c commit d118808

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
![mapping](https://i.imgur.com/qKqYjU9.jpeg)
88

9+
[Function-specific documentation](https://antsx.github.io/ANTsPyMM/antspymm/mm.html)
10+
911
## processing utilities for timeseries/multichannel images - mostly neuroimaging
1012

1113
the outputs of these processes can be used for data inspection/cleaning/triage
@@ -512,3 +514,12 @@ python3 -m twine upload --repository antspymm dist/*
512514
```bash
513515
nohup psrecord --interval 5 --log mem_log.txt --plot mem_plot.png -- docs/mm_csv_localint_sr.py > /tmp/sr_mem_record.txt
514516
```
517+
518+
## to publish docs
519+
520+
```bash
521+
pdoc antspymm -o docs
522+
git add docs/ && git commit -m "DOC: update docs" && git push
523+
# Settings → Pages → Source = main, Folder = /docs
524+
```
525+

0 commit comments

Comments
 (0)