Skip to content

Commit fc2580a

Browse files
committed
MNT rename tutorials to clarify one is deprecated
1 parent 3df639d commit fc2580a

32 files changed

Lines changed: 56 additions & 57 deletions

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,11 @@ To explore these tutorials, one can:
2323
- run the Jupyter notebooks located in the
2424
`tutorials/notebooks <tutorials/notebooks>`_ directory
2525
- run the merged notebook in
26-
`Colab <https://colab.research.google.com/github/gallantlab/voxelwise_tutorials/blob/main/tutorials/notebooks/movies_3T/merged_for_colab.ipynb>`_.
26+
`Colab <https://colab.research.google.com/github/gallantlab/voxelwise_tutorials/blob/main/tutorials/notebooks/movies/merged_for_colab.ipynb>`_.
2727

2828
To run the tutorials yourself, first download this repository, and install the
2929
dependencies (see below). The tutorials are best explored in order, starting
30-
with the "Movies 3T" tutorial.
30+
with the "Movies" tutorial.
3131

3232
Helper Python package
3333
=====================

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ notebooks:
3333
python create_notebooks.py
3434
$(MAKE) merge-notebooks
3535

36-
NBDIR = ../tutorials/notebooks/movies_3T
36+
NBDIR = ../tutorials/notebooks/movies
3737

3838
merge-notebooks:
3939
python merge_notebooks.py \

doc/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,11 @@ sphinx_gallery
1111
## Build commands
1212

1313
```bash
14-
make clean # Remove all files generated by the website build
15-
make html # Build the website, running all the examples (slow)
16-
make html-noplot # Build the website, without running all the examples (fast)
17-
make notebooks # Update the notebooks directory, *after* building the website
14+
make clean # Remove all files generated by the website build
15+
make html # Build the website, running all the examples (slow)
16+
make html-noplot # Build the website, without running all the examples (fast)
17+
make notebooks # Update the notebooks directory, *after* building the website
18+
make merge-notebooks # Merge notebooks for Colab, *after* making the notebooks
1819

1920
firefox _build/html/index.html # Open the built website
2021
```
@@ -31,6 +32,7 @@ firefox _build/html/index.html
3132
```bash
3233
make html-noplot
3334
make notebooks
35+
make merge-notebooks
3436
```
3537

3638
## Push the website

doc/index.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,9 @@ To explore these tutorials, one can:
2121
<https://github.com/gallantlab/voxelwise_tutorials/tree/main/tutorials/notebooks>`_
2222
directory)
2323
- run the merged notebook in
24-
`Colab <https://colab.research.google.com/github/gallantlab/voxelwise_tutorials/blob/main/tutorials/notebooks/movies_3T/merged_for_colab.ipynb>`_.
24+
`Colab <https://colab.research.google.com/github/gallantlab/voxelwise_tutorials/blob/main/tutorials/notebooks/movies/merged_for_colab.ipynb>`_.
2525

26-
The tutorials are best explored in order, starting with the "Movies 3T"
27-
tutorial.
26+
The tutorials are best explored in order, starting with the "Movies" tutorial.
2827

2928
The project is available on GitHub at `gallantlab/voxelwise_tutorials
3029
<https://github.com/gallantlab/voxelwise_tutorials>`_. On top of the tutorials,
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)