You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ All the tutorials are now presented as sphinx style documentation at:
12
12
We use sphinx-gallery's [notebook styled examples](https://sphinx-gallery.readthedocs.io/en/latest/tutorials/plot_notebook.html#sphx-glr-tutorials-plot-notebook-py) to create the tutorials. Syntax is very simple. In essence, you write a slightly well formatted python file and it shows up as documentation page.
13
13
14
14
Here's how to create a new tutorial:
15
-
1. Create a notebook styled python file. If you want it executed while inserted into documentation, save the file as`your_tutorial.py`.
15
+
1. Create a notebook styled python file. If you want it executed while inserted into documentation, save the file with suffix `tutorial` so that file name is`your_tutorial.py`.
16
16
2. Put it in one of the beginner_source, intermediate_source, advanced_source based on the level.
17
17
2. Include it in the right TOC tree at index.rst
18
18
3. Create a thumbnail in the index file using a command like `.. galleryitem:: beginner/your_tutorial.py`. (This is a custom directive. Argument should be a full path to the python file without a slash at the beginning.)
0 commit comments