Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 08db4b4

Browse files
authored
Update README.md
1 parent 0cd7e78 commit 08db4b4

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ All the tutorials are now presented as sphinx style documentation at:
1212
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.
1313

1414
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`.
1616
2. Put it in one of the beginner_source, intermediate_source, advanced_source based on the level.
1717
2. Include it in the right TOC tree at index.rst
1818
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

Comments
 (0)