"This is text in a markdown cell of the notebook. This is simple a notebook to test the notebook visualization in sphinx. To create an example notebook for the documentation:\n",
"\n",
"- create a notebook, this example is called 'test_notebook.ipynb'\n",
"- IMPORTANT: all notebooks needs to have a heading like '# Something'\n",
"- execute all cells of the notebook in order (for proper numbering of in and output)\n",
"- save the notebook to docs/examples/\n",
"- link the example in 'docs/examples.rst' like follows"
...
...
@@ -1124,7 +1125,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.8.12"
"version": "3.8.8"
}
},
"nbformat": 4,
...
...
%% Cell type:markdown id:acaf9bb4 tags:
# This a heading in a markdown cell of the notebook
This is text in a markdown cell of the notebook. This is simple a notebook to test the notebook visualization in sphinx. To create an example notebook for the documentation:
- create a notebook, this example is called 'test_notebook.ipynb'
- IMPORTANT: all notebooks needs to have a heading like '# Something'
- execute all cells of the notebook in order (for proper numbering of in and output)
- save the notebook to docs/examples/
- link the example in 'docs/examples.rst' like follows
%% Cell type:raw id:8aa42f15 tags:
.. toctree::
:maxdepth: 4
:caption: Examples:
Test example <examples/test_notebook.ipynb>
%% Cell type:markdown id:9d0bc5d2 tags:
Now comes the example
%% Cell type:code id:8f3404a3 tags:
``` python
%matplotlibnotebook
importnumpyasnp
importmatplotlib.pyplotasplt
```
%% Cell type:markdown id:22b7090c tags:
We will just do some stuff here inbetween, and explain things.