Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] add links in doc #1269

Merged
merged 2 commits into from
Jul 8, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion demos/bayes/Makefile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: clean data data_ds000001
.PHONY: clean

clean:
rm -rf inputs
Expand Down
File renamed without changes.
15 changes: 12 additions & 3 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,18 @@

source_suffix = [".rst", ".md"]

# intersphinx_mapping = {
# "bids-matlab": ("https://bids-matlab.readthedocs.io/en/main", None)
# }
intersphinx_mapping = {
"bids-matlab": ("https://bids-matlab.readthedocs.io/en/main", None),
"nilearn": ("https://nilearn.github.io/stable", None),
}

# We recommend adding the following config value.
# Sphinx defaults to automatically resolve *unresolved* labels using all your Intersphinx mappings.
# This behavior has unintended side-effects, namely that documentations local references can
# suddenly resolve to an external location.
# See also:
# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
# intersphinx_disabled_reftypes = ["*"]

coverage_show_missing_items = True

Expand Down
6 changes: 3 additions & 3 deletions docs/source/demos/bayesian_model_selection.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ Bayesian model selection

.. automodule:: demos.bayes

.. autoscript:: ds000114_run
.. autoscript:: ds000114_bayes_run

.. admonition:: script
:class: dropdown

.. literalinclude:: ../../../demos/bayes/ds000114_run.m
.. literalinclude:: ../../../demos/bayes/ds000114_bayes_run.m
:language: matlab
:caption: demos/bayes/ds000114_run.m
:caption: demos/bayes/ds000114_bayes_run.m
:lines: 16-

.. admonition:: Default BIDS stats model
Expand Down
28 changes: 20 additions & 8 deletions docs/source/demos/openneuro.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

## ds000001: Balloon analog risk

- [Source dataset](https://openneuro.org/datasets/ds000001)

### Features

- one task
Expand All @@ -26,6 +28,8 @@

## ds000114: test-retest

- [Source dataset](https://openneuro.org/datasets/ds000114)

### Features

- several tasks
Expand All @@ -40,6 +44,8 @@

## ds000224

- [Source dataset](https://openneuro.org/datasets/ds000224)

### Scripts

```{eval-rst}
Expand All @@ -48,6 +54,8 @@

## ds001168

- [Source dataset](https://openneuro.org/datasets/ds001168)

### Features

- resting state
Expand All @@ -62,16 +70,10 @@
.. autoscript:: ds001168_run
```

## ds002799: NARPS

### Features

- resting state and task
- several sessions
- fmriprep data

## ds001734: NARPS

- [Source dataset](https://openneuro.org/datasets/ds001734)

### Features

- one task
Expand Down Expand Up @@ -127,3 +129,13 @@ transformers cannot yet be appled to confounds
```{eval-rst}
.. autoscript:: ds001734_run
```

## ds002799

- [Source dataset](https://openneuro.org/datasets/ds002799)

### Features

- resting state and task
- several sessions
- fmriprep data
2 changes: 1 addition & 1 deletion src/batches/setBatchSelectAnat.m
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
% :type matlabbatch: structure
%
% :param BIDS: dataset layout.
% See: bids.layout, getData.
% See: :mat:func:`+bids.layout`, :func:`getData`.
%
% :type BIDS: structure
%
Expand Down
3 changes: 1 addition & 2 deletions src/bids_model/addConfoundsToDesignMatrix.m
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
%
% This will update the design matrix of the root node of the model.
%
% Similar to the module
% https://nilearn.github.io/dev/modules/generated/nilearn.interfaces.fmriprep.load_confounds.html
% Similar to the :func:`nilearn.interfaces.fmriprep.load_confounds`
%
% USAGE::
%
Expand Down
Loading