add user guide (#513)

clewis7 · kushalkolar · web-flow · commit d0b8bb13714f · 2024-06-23T01:11:07.000+02:00
* start guide based on new API changes

* Update guide.rst

* progress on guide

* guide updates

* add spaces and interactive use sections

* add selectors to guide

* guide updates

* rough draft

* Apply suggestions from code review

Co-authored-by: Kushal Kolar &lt;kushalkolar@gmail.com&gt;

* update guide

---------

Co-authored-by: Kushal Kolar &lt;kushalkolar@gmail.com&gt;
diff --git a/docs/source/_static/guide_animation.gif b/docs/source/_static/guide_animation.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0b69ad02a527f4c7353cb94ce22deedd92134e84b2cc0776bf81f3d0083d0e37
+size 4095880
diff --git a/docs/source/_static/guide_hello_world.png b/docs/source/_static/guide_hello_world.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:81fdee4dda9bbc46d810a6e80ddc4d6ceb8ff0db8dfea2faf90424f977c000d4
+size 201157
diff --git a/docs/source/_static/guide_hello_world_data.png b/docs/source/_static/guide_hello_world_data.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:cda3395fb158706eeffc669f3f7cf09b99316870e32f51f69aedc9a6f1590ddb
+size 123621
diff --git a/docs/source/_static/guide_hello_world_vmax.png b/docs/source/_static/guide_hello_world_vmax.png
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:36902d1e082730af8dc383ff7f89434c93b9e605f0410dd199d39495cd61c552
+size 143561
diff --git a/docs/source/_static/guide_image_widget.gif b/docs/source/_static/guide_image_widget.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4a3c90078ab4ec8552c4eac199c726d413c89ec63143988e3ea0fca5114393d6
+size 2122357
diff --git a/docs/source/_static/guide_linear_selector.gif b/docs/source/_static/guide_linear_selector.gif
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:acf1cab72eb4d268581b26295e47cd0ca9aebe08beaf80e1424b100086ed59ca
+size 331446
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -100,7 +100,7 @@
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "numpy": ("https://numpy.org/doc/stable/", None),
-    "pygfx": ("https://pygfx.com/latest", None),
+    "pygfx": ("https://pygfx.com/stable", None),
     "wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
 }
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -5,6 +5,7 @@ Welcome to fastplotlib's documentation!
    :caption: User Guide
    :maxdepth:  2
 
+   Guide <user_guide/guide.rst>
    GPU Info <user_guide/gpu>
 
 .. toctree::
diff --git a/docs/source/user_guide/guide.rst b/docs/source/user_guide/guide.rst

Original file line number	Diff line number	Diff line change
`@@ -100,7 +100,7 @@`
`100`	`100`	`intersphinx_mapping = {`
`101`	`101`	`"python": ("https://docs.python.org/3", None),`
`102`	`102`	`"numpy": ("https://numpy.org/doc/stable/", None),`
`103`		`- "pygfx": ("https://pygfx.com/latest", None),`
	`103`	`+ "pygfx": ("https://pygfx.com/stable", None),`
`104`	`104`	`"wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),`
`105`	`105`	`}`
`106`	`106`