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

Skip to content

Commit 0cd7e78

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

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ All the tutorials are now presented as sphinx style documentation at:
77

88

99

10-
## Contributing
10+
# Contributing
1111

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

@@ -16,3 +16,5 @@ Here's how to create a new tutorial:
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.)
19+
20+
In case you prefer to write your tutorial in jupyter, you can use [this script](https://gist.github.com/chsasank/7218ca16f8d022e02a9c0deb94a310fe) to convert the notebook to python file. After conversion and addition to the project, please make sure the sections headings etc are in logical order.

0 commit comments

Comments
 (0)