Skip to content

Commit efbb8c1

Browse files
authored
fix guide (#536)
1 parent d0b8bb1 commit efbb8c1

File tree

5 files changed

+19
-15
lines changed

5 files changed

+19
-15
lines changed
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 2 additions & 2 deletions
Loading
Lines changed: 2 additions & 2 deletions
Loading

docs/source/user_guide/guide.rst

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ or install the bleeding edge from Github:
1818
1919
2020
What is ``fastplotlib``?
21-
----------------------
21+
------------------------
2222

2323
``fastplotlib`` is a cutting-edge plotting library built using the ```pygfx`` <https://github.com/pygfx/pygfx>`_ rendering engine.
2424
The lower-level details of the rendering process (i.e. defining a scene, camera, renderer, etc.) are abstracted away, allowing users to focus on their data.
@@ -27,7 +27,7 @@ make it easy and intuitive to produce interactive visualizations that are as per
2727

2828

2929
How to use ``fastplotlib``
30-
------------------------
30+
--------------------------
3131

3232
Before giving a detailed overview of the library, here is a minimal example::
3333

@@ -49,7 +49,7 @@ Before giving a detailed overview of the library, here is a minimal example::
4949
if __name__ == "__main__":
5050
fpl.run()
5151

52-
.. image:: ./_static/guide_hello_world.png
52+
.. image:: ../_static/guide_hello_world.png
5353

5454

5555
This is just a simple example of how the ``fastplotlib`` API works to create a plot, add some image data to the plot, and then visualize it.
@@ -173,14 +173,14 @@ Using our example from above: once we add a ``Graphic`` to the figure, we can th
173173

174174
image_graphic.vmax = 150
175175

176-
.. image:: ./_static/hello_world_vmax.png
176+
.. image:: ../_static/guide_hello_world_vmax.png
177177

178178
``Graphic`` properties also support slicing and indexing. For example ::
179179

180180
image_graphic.data[::8, :, :] = 1
181181
image_graphic.data[:, ::8, :] = 1
182182

183-
.. image:: ./_static/hello_world_data.png
183+
.. image:: ../_static/guide_hello_world_data.png
184184

185185

186186
Selectors
@@ -211,7 +211,7 @@ data. Let's look at an example: ::
211211

212212
fig.show(maintain_aspect=False)
213213

214-
.. image:: _static/guide_linear_selector.gif
214+
.. image:: ../_static/guide_linear_selector.gif
215215

216216

217217
A ``LinearRegionSelector`` is very similar to a ``LinearSelector`` but as opposed to selecting a singular point of
@@ -448,7 +448,8 @@ For example: ::
448448
nearest.colors = "w"
449449

450450
fig.show()
451-
.. image:: ./_static/click_event.gif
451+
452+
.. image:: ../_static/click_event.gif
452453

453454
ImageWidget
454455
-----------
@@ -472,7 +473,7 @@ to easily navigate through different dimensions of your data. Let's look at an e
472473

473474
iw_movie.show()
474475

475-
.. image:: _static/guide_image_widget.gif
476+
.. image:: ../_static/guide_image_widget.gif
476477

477478
Animations
478479
----------
@@ -496,7 +497,7 @@ An animation function is a user-defined function that gets called on every rende
496497

497498
fig.show()
498499

499-
.. image:: _static/guide_animation.gif
500+
.. image:: ../_static/guide_animation.gif
500501

501502
Here we are defining a function that updates the data of the ``ImageGraphic`` in the plot with new random data. When adding an animation function, the
502503
user-defined function will receive a plot instance as an argument when it is called.

0 commit comments

Comments
 (0)