Skip to content

Commit

Permalink
add back tutorial template
Browse files Browse the repository at this point in the history
  • Loading branch information
yalinli2 committed Sep 14, 2021
1 parent 6608976 commit b239653
Show file tree
Hide file tree
Showing 2 changed files with 92 additions and 2 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@ _build
prof
*Pyreverse*
monkeytype.sqlite3

# Spyder
*.spyproject*

# Docs #
Expand All @@ -25,8 +27,6 @@ monkeytype.sqlite3
**/_demo.py
**/.ipynb_checkpoints
**/.pylint.d
docs/tutorial/.ipynb_checkpoints
docs/.ipynb_checkpoints
docs/build/*

# Compiled source #
Expand Down
90 changes: 90 additions & 0 deletions docs/source/for_developers/Tutorial_Template.ipynb
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial Template <a class=\"anchor\" id=\"top\"></a>\n",
"\n",
"- **Prepared by:**\n",
" \n",
" - [Author 1](mailto:email_address@if_wanted.com)\n",
" - Author 2\n",
"\n",
"- **Covered topics:**\n",
"\n",
" - [1. Section title](#s1)\n",
" - [2. Module XX](#s2)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**Note:**\n",
"If adding a hyperlink to some text, do NOT add other formatting, otherwise it won't be correctly rendered by Sphinx (used for the online [tutorial](https://qsdsan.readthedocs.io). But it's OK to format the destination of the hyperlink."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## 1. Section title <a class=\"anchor\" id=\"s1\"></a>"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## 2. `Module XX` <a class=\"anchor\" id=\"s2\"></a>"
]
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"QSDsan version is v0.3.2.\n"
]
}
],
"source": [
"import qsdsan as qs\n",
"# This way other people will know which version you use when writing the tutorial\n",
"print(f'QSDsan version is v{qs.__version__}.')"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"[Back to top](#top)"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.2"
}
},
"nbformat": 4,
"nbformat_minor": 4
}

0 comments on commit b239653

Please sign in to comment.