Skip to content

Commit 98ddc92

Browse files
committed
Fix documentation build errors in index.rst
- Remove references to non-existent files in toctree - Consolidate API reference into main toctree - Add missing imports to FreeSurfer example - Ensures Surface Visualization section displays properly
1 parent 766c61d commit 98ddc92

File tree

1 file changed

+19
-30
lines changed

1 file changed

+19
-30
lines changed

docs/source/index.rst

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,24 @@ A comprehensive Python toolkit for neuroimaging data processing and analysis, sp
1010

1111
.. toctree::
1212
:maxdepth: 2
13-
:caption: Contents:
13+
:caption: API Reference:
1414

15-
installation
16-
quickstart
17-
api
18-
examples
19-
contributing
20-
changelog
15+
modules/bidstools
16+
modules/connectivitytools
17+
modules/dicomtools
18+
modules/dwitools
19+
modules/freesurfertools
20+
modules/imagetools
21+
modules/misctools
22+
modules/morphometrytools
23+
modules/networktools
24+
modules/parcellationtools
25+
modules/pipelinetools
26+
modules/plottools
27+
modules/qcqatools
28+
modules/segmentationtools
29+
modules/surfacetools
30+
modules/visualizationtools
2131

2232
Installation
2333
============
@@ -39,7 +49,6 @@ Quick Start
3949

4050
Surface Visualization
4151
=====================
42-
4352
.. code-block:: python
4453
import clabtoolkit.surfacetools as cltsurf
4554
@@ -58,7 +67,9 @@ Working with FreeSurfer
5867
=======================
5968
.. code-block:: python
6069
70+
import os
6171
import clabtoolkit.freesurfertools as cltfree
72+
import clabtoolkit.misctools as cltmisc
6273
6374
# Get the FREESURFER_HOME environment variable
6475
freesurfer_home = os.environ.get('FREESURFER_HOME')
@@ -76,28 +87,6 @@ Working with FreeSurfer
7687
print(f"Subject Directory: ")
7788
cltmisc.print_dict_tree(subject.fs_files)
7889
79-
API Reference
80-
=============
81-
82-
.. toctree::
83-
:maxdepth: 2
84-
85-
modules/bidstools
86-
modules/connectivitytools
87-
modules/dicomtools
88-
modules/dwitools
89-
modules/freesurfertools
90-
modules/imagetools
91-
modules/misctools
92-
modules/morphometrytools
93-
modules/networktools
94-
modules/parcellationtools
95-
modules/pipelinetools
96-
modules/plottools
97-
modules/qcqatools
98-
modules/segmentationtools
99-
modules/surfacetools
100-
modules/visualizationtools
10190
10291
Indices and tables
10392
==================

0 commit comments

Comments
 (0)