|
1 | | -# Code and Output |
| 1 | +# Include Notebook Section |
2 | 2 |
|
3 | | -Use `include-jupyter` to include [Jupyter](https://jupyter.org/) notebook inside your documentation. |
| 3 | +Use `include-jupyter` to include a jupyter notebook or one of its parts. |
| 4 | +Here is an example of a notebook: |
4 | 5 |
|
5 | | - :include-jupyter: jupyter/simple-notebook.ipynb |
6 | | - |
7 | | -:include-jupyter: jupyter/simple-notebook.ipynb |
| 6 | +:include-image: jupyter/notebook.png {fit: true, border: true} |
8 | 7 |
|
9 | | -Note: Remember that you can define lookup paths for files like notebooks inside [lookup-paths](flow/lookup-paths) file, so you don't have |
10 | | -to copy and paste notebooks to your documentation directory. |
| 8 | +To include one of its sections use, |
11 | 9 |
|
12 | | -# Seamless Markdown Integration |
| 10 | +``` |
| 11 | +:include-jupyter: jupyter/notebook.ipynb { |
| 12 | + includeSection: ["Loading Data From CSV"] |
| 13 | +} |
| 14 | +``` |
13 | 15 |
|
14 | | -Markdown from your notebook will be seamlessly integrated into your current page. First level `# headers` will |
15 | | -become part of Table Of Contents and part of a search unit. |
| 16 | +Markdown cells will be seamlessly integrated with the current page. |
| 17 | +Top level headers become this page top level header. |
16 | 18 |
|
17 | | -:include-image: jupyter/notebook.png {fit: true} |
| 19 | +Note: without `includeSection`, the entire notebook content will be added. |
18 | 20 |
|
19 | | - :include-jupyter: notebook-with-markdown-story.ipynb |
| 21 | +:include-jupyter: jupyter/notebook.ipynb { |
| 22 | + includeSection: ["Loading Data From CSV"] |
| 23 | +} |
20 | 24 |
|
21 | | -Note: below text is auto generated, including the **Panda** section |
22 | | -:include-jupyter: src/test/resources/notebook-with-markdown-story.ipynb |
| 25 | +Note: Remember that you can define lookup paths for files like notebooks inside [lookup-paths](flow/lookup-paths) file, so you don't have |
| 26 | +to copy and paste notebooks to your documentation directory. |
23 | 27 |
|
24 | | -# Include Only Specified Sections |
| 28 | +# Exclude Section Title |
25 | 29 |
|
26 | | -Use `includeSection` to select which sections of the notebook to include. |
| 30 | +Use `excludeSectionTitle` to exclude section title. It can be useful when you |
| 31 | +want to use section titles as example separators to be included into your guides. |
27 | 32 |
|
28 | 33 | ``` |
29 | | -:include-jupyter: notebook.ipynb { |
30 | | - includeSection: ["Section One"; "Section Three"], |
| 34 | +:include-jupyter: jupyter/notebook.ipynb { |
| 35 | + includeSection: ["Average Prcing By Genre"], |
31 | 36 | excludeSectionTitle: true |
32 | 37 | } |
33 | 38 | ``` |
34 | 39 |
|
| 40 | +:include-jupyter: jupyter/notebook.ipynb { |
| 41 | + includeSection: ["Average Pricing By Genre"], |
| 42 | + excludeSectionTitle: true |
| 43 | +} |
| 44 | + |
35 | 45 | # Two Sides |
36 | 46 |
|
37 | 47 | You will learn about the [Two Sides Layout](layout/two-sides-pages) in the Layout section. |
|
0 commit comments