Skip to content

Commit

Permalink
[DOC] reorder classes and functions in doc (nilearn#4766)
Browse files Browse the repository at this point in the history
  • Loading branch information
@Remi-Gau
Remi-Gau authored Nov 20, 2024
1 parent 4bcd033 commit 94fd3b3
Show file tree
Hide file tree
Showing 15 changed files with 86 additions and 54 deletions.
6 changes: 4 additions & 2 deletions doc/modules/connectome.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
-------

.. currentmodule:: nilearn.connectome

Expand All @@ -19,7 +20,8 @@
GroupSparseCovariance
GroupSparseCovarianceCV

**Functions**:
Functions
---------

.. currentmodule:: nilearn.connectome

Expand Down
15 changes: 10 additions & 5 deletions doc/modules/datasets.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
Templates
---------

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.datasets

Expand Down Expand Up @@ -48,7 +49,8 @@ Templates descriptions
Atlases
-------

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.datasets

Expand Down Expand Up @@ -102,7 +104,8 @@ Atlases descriptions
Preprocessed datasets
---------------------

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.datasets

Expand Down Expand Up @@ -148,7 +151,8 @@ Datasets descriptions
Statistical maps/derivatives
----------------------------

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.datasets

Expand Down Expand Up @@ -178,7 +182,8 @@ Statistical maps/derivatives descriptions
General functions
-----------------

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.datasets

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/decoding.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
-------

.. currentmodule:: nilearn.decoding

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/decomposition.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
-------

.. currentmodule:: nilearn.decomposition

Expand Down
18 changes: 12 additions & 6 deletions doc/modules/glm.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

.. No relevant user manual section yet.
**Classes**:
Classes
-------

.. currentmodule:: nilearn.glm

Expand All @@ -26,7 +27,8 @@
RegressionResults
SimpleRegressionResults

**Functions**:
Functions
---------

.. currentmodule:: nilearn.glm

Expand All @@ -49,7 +51,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
^^^^^^^

.. currentmodule:: nilearn.glm.first_level

Expand All @@ -59,7 +62,8 @@

FirstLevelModel

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.glm.first_level

Expand Down Expand Up @@ -87,7 +91,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
^^^^^^^

.. currentmodule:: nilearn.glm.second_level

Expand All @@ -97,7 +102,8 @@

SecondLevelModel

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.glm.second_level

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/image.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:no-members:
:no-inherited-members:

**Functions**:
Functions
---------

.. currentmodule:: nilearn.image

Expand Down
9 changes: 6 additions & 3 deletions doc/modules/interfaces.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@
:no-members:
:no-inherited-members:

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.interfaces.bids

Expand All @@ -33,7 +34,8 @@
:no-members:
:no-inherited-members:

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.interfaces.fmriprep

Expand All @@ -51,7 +53,8 @@
:no-members:
:no-inherited-members:

**Functions**:
Functions
^^^^^^^^^

.. currentmodule:: nilearn.interfaces.fsl

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/maskers.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

**User guide:** See the :ref:`nifti_masker` section for further details.

**Classes**:
Classes
-------

.. currentmodule:: nilearn.maskers

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/masking.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

**User guide:** See the :ref:`masking` section for further details.

**Functions**:
Functions
---------

.. currentmodule:: nilearn.masking

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/mass_univariate.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

.. No relevant user manual section yet.
**Functions**:
Functions
---------

.. currentmodule:: nilearn.mass_univariate

Expand Down
29 changes: 16 additions & 13 deletions doc/modules/plotting.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

.. No relevant user manual section yet.
**Functions**:
Functions
---------

.. currentmodule:: nilearn.plotting

Expand Down Expand Up @@ -58,18 +59,8 @@

.. No relevant user manual section yet.
**Functions**:

.. currentmodule:: nilearn.plotting.displays

.. autosummary::
:toctree: generated/
:template: function.rst

get_projector
get_slicer

**Classes**:
Classes
^^^^^^^

.. currentmodule:: nilearn.plotting.displays

Expand Down Expand Up @@ -105,3 +96,15 @@
XSlicer
YSlicer
ZSlicer

Functions
^^^^^^^^^

.. currentmodule:: nilearn.plotting.displays

.. autosummary::
:toctree: generated/
:template: function.rst

get_projector
get_slicer
30 changes: 16 additions & 14 deletions doc/modules/regions.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,22 @@
:no-members:
:no-inherited-members:

**Functions**:
Classes
-------

.. currentmodule:: nilearn.regions

.. autosummary::
:toctree: generated/
:template: class.rst

RegionExtractor
Parcellations
ReNA
HierarchicalKMeans

Functions
---------

.. currentmodule:: nilearn.regions

Expand All @@ -20,16 +35,3 @@
img_to_signals_maps
signals_to_img_maps
recursive_neighbor_agglomeration

**Classes**:

.. currentmodule:: nilearn.regions

.. autosummary::
:toctree: generated/
:template: class.rst

RegionExtractor
Parcellations
ReNA
HierarchicalKMeans
6 changes: 4 additions & 2 deletions doc/modules/reporting.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
:no-members:
:no-inherited-members:

**Classes**:
Classes
-------

.. currentmodule:: nilearn.reporting

Expand All @@ -17,7 +18,8 @@

HTMLReport

**Functions**:
Functions
---------

.. currentmodule:: nilearn.reporting

Expand Down
3 changes: 2 additions & 1 deletion doc/modules/signal.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@

.. No relevant user manual section yet.
**Functions**:
Functions
---------

.. currentmodule:: nilearn.signal

Expand Down
6 changes: 4 additions & 2 deletions doc/modules/surface.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@

.. No relevant user manual section yet.
**Classes**:
Classes
-------

.. currentmodule:: nilearn.surface

Expand All @@ -22,7 +23,8 @@
SurfaceImage
SurfaceMesh

**Functions**:
Functions
---------

.. currentmodule:: nilearn.surface

Expand Down

0 comments on commit 94fd3b3

Please sign in to comment.