Plywood Gallery

Bringing example branching into python documentation via notebooks.

by Jan-Hendrik Müller and Ricky Alinsky

Plywood Gallery

A new framework to generate python documentation via notebooks.
Code snippets are represented by images.
Show code variations with example branching.

Next:
Demos of Jupyter generated documentation webpages.

Webpage on [GitHubPages](https://kolibril13.github.io/plywood-gallery-2D-array/) by [@kolibril13](https://github.com/kolibril13)

</div>

---

Webpage on [GitHubPages](https://kolibril13.github.io/plywood-gallery-functions/) by [@kolibril13](https://github.com/kolibril13)
				
				</div>

---

Webpage on [GitHubPages](https://kolibril13.github.io/plywood-gallery-pathlib/) by [@kolibril13](https://github.com/kolibril13)
				
				</div>

---

Webpage on [GitHubPages](https://kolibril13.github.io/plywood-gallery-napari/) by [@kolibril13](https://github.com/kolibril13)
				
				</div>

Current Galleries:

2D-array, functions, pathlib, napari, f-string, 3D-array, matplotlib-ImageGrid, minimal-example

To see them as Iframes press the "Down" Button.

<div style="font-size: 30px"> Installation and Quickstart.</div>
				<pre><code data-trim data-noescape data-line-numbers="1|2|3-4|5|6-7|8"> 
				$ pip install plywood-gallery
				$ python 
				>>> from plywood_gallery import quickstart, generate_html
				>>> quickstart()
				>>> # Now: details in gallery_config.yaml
				>>> generate_html(yaml_file="gallery_config.yaml", 
					html_file="index.html")
				>>> # Now: Open Index.html
				</code></pre>

---
				<div style="font-size: 30px"> Project after quickstart</div>

---

<div style="font-size: 30px"> Activate GitHub Pages</div>

---

<div style="font-size: 30px"> Next: Creating a gallery.</div>

---
				<div>
					<video  controls width="90%" src="assets/c1.mov">
				</div>
	
				<div style="font-size: 20px; text-align: justify;position: absolute;
				left: 60px; bottom: -40px; ">

Notebook on [GitHub](https://github.com/kolibril13/plywood-gallery-functions/blob/6e097964f04df03b709aa47687a168fad1e6e312/nb5_functions.ipynb) by [@kolibril13](https://github.com/kolibril13)
				</div>
				---

<div style="font-size: 30px"> Next: Plywood-Gallery VS Code Extension.</div>

---

<div style="font-size: 30px"> Install Extension</div>

---

Download galleries
				<div>
					<video controls width="90%" src="assets/VS1.mov">
				</div>
				
				<div style="font-size: 20px; text-align: justify;position: absolute;
				left: 75px; bottom: -40px; ">

Project on [GitHub](https://github.com/Rickaym/plywood-gallery-for-vscode) by [@Rickaym](https://github.com/Rickaym) 
				</div>

---

Insert
				<div>
					<video data-autoplay controls width="90%" src="assets/VS2.mov">
				</div>
				
				<div style="font-size: 20px; text-align: justify;position: absolute;
				left: 75px; bottom: -40px; ">

Project on [GitHub](https://github.com/Rickaym/plywood-gallery-for-vscode) by [@Rickaym](https://github.com/Rickaym) 
				</div>

Thank you for your attention.