fastplotlib · apasarkar · Dec 25, 2025 · Dec 27, 2025 · Dec 27, 2025 · Dec 28, 2025
@@ -49,7 +49,7 @@ jobs:
       - name: build docs
         run: |
           cd docs
-          RTD_BUILD=1 make html SPHINXOPTS="-W --keep-going"
+          DOCS_BUILD=1 make html SPHINXOPTS="-W --keep-going"
 
       # set environment variable `DOCS_VERSION_DIR` to either the pr-branch name, "dev", or the release version tag
       - name: set output pr

@@ -63,31 +63,28 @@ Questions, issues, ideas? You are welcome to post an [issue](https://github.com/
 
 To install use pip:
 
-```bash
-# with imgui and jupyterlab
-pip install -U "fastplotlib[notebook,imgui]"
+### With imgui support (recommended)
 
-# minimal install, install glfw, pyqt6 or pyside6 separately
-pip install -U fastplotlib
+Without jupyterlab support, install desired GUI framework such as glfw, PyQt6, or PySide6 separately.
 
-# with imgui
-pip install -U "fastplotlib[imgui]"
+    pip install -U "fastplotlib[imgui]"
 
-# to use in jupyterlab without imgui
-pip install -U "fastplotlib[notebook]"
-```
+With jupyterlab support.
 
-We strongly recommend installing ``simplejpeg`` for use in notebooks, you must first install [libjpeg-turbo](https://libjpeg-turbo.org/)
+    pip install -U "fastplotlib[notebook,imgui]"
 
-- If you use ``conda``, you can get ``libjpeg-turbo`` through conda.
-- If you are on linux, you can get it through your distro's package manager.
-- For Windows and Mac compiled binaries are available on their release page: https://github.com/libjpeg-turbo/libjpeg-turbo/releases
+### Without imgui
 
-Once you have ``libjpeg-turbo``:
+Minimal, install desired GUI library such as PyQt6, PySide6, or glfw separately.
+
+    pip install fastplotlib
+
+With jupyterlab support only.
+
+    pip install -U "fastplotlib[notebook]"
+
+Fastplotlib is also available on conda-forge. For imgui support you will need to separately install `imgui-bundle`, and for jupyterlab you will need to install `jupyter-rfb` and `simplejpeg` which are all available on conda-forge.
 
-```bash
-pip install simplejpeg
-```
 
 > **Note:**
 > `fastplotlib` and `pygfx` are fast evolving projects, the version available through pip might be outdated, you will need to follow the "For developers" instructions below if you want the latest features. You can find the release history here: https://github.com/fastplotlib/fastplotlib/releases

@@ -0,0 +1,44 @@
+.. _api.Axes:
+
+Axes
+****
+
+====
+Axes
+====
+.. currentmodule:: fastplotlib.axes
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: Axes_api
+
+    Axes
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: Axes_api
+
+    Axes.auto_grid
+    Axes.basis
+    Axes.color
+    Axes.colors
+    Axes.grids
+    Axes.intersection
+    Axes.offset
+    Axes.visible
+    Axes.world_object
+    Axes.x
+    Axes.y
+    Axes.z
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: Axes_api
+
+    Axes.update
+    Axes.update_using_bbox
+    Axes.update_using_camera
+
@@ -0,0 +1,66 @@
+.. _api.Grid:
+
+Grid
+****
+
+====
+Grid
+====
+.. currentmodule:: fastplotlib.axes
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: Grid_api
+
+    Grid
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: Grid_api
+
+    Grid.axis_color
+    Grid.axis_thickness
+    Grid.cast_shadow
+    Grid.children
+    Grid.geometry
+    Grid.id
+    Grid.infinite
+    Grid.major_color
+    Grid.major_step
+    Grid.major_thickness
+    Grid.material
+    Grid.minor_color
+    Grid.minor_step
+    Grid.minor_thickness
+    Grid.parent
+    Grid.receive_shadow
+    Grid.render_mask
+    Grid.render_order
+    Grid.thickness_space
+    Grid.up
+    Grid.visible
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: Grid_api
+
+    Grid.add
+    Grid.add_event_handler
+    Grid.clear
+    Grid.get_bounding_box
+    Grid.get_bounding_sphere
+    Grid.get_geometry_bounding_box
+    Grid.get_world_bounding_box
+    Grid.get_world_bounding_sphere
+    Grid.handle_event
+    Grid.iter
+    Grid.look_at
+    Grid.release_pointer_capture
+    Grid.remove
+    Grid.remove_event_handler
+    Grid.set_pointer_capture
+    Grid.traverse
+
@@ -0,0 +1,59 @@
+.. _api.Grids:
+
+Grids
+*****
+
+=====
+Grids
+=====
+.. currentmodule:: fastplotlib.axes
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: Grids_api
+
+    Grids
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: Grids_api
+
+    Grids.cast_shadow
+    Grids.children
+    Grids.geometry
+    Grids.id
+    Grids.material
+    Grids.parent
+    Grids.receive_shadow
+    Grids.render_mask
+    Grids.render_order
+    Grids.up
+    Grids.visible
+    Grids.xy
+    Grids.xz
+    Grids.yz
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: Grids_api
+
+    Grids.add
+    Grids.add_event_handler
+    Grids.clear
+    Grids.get_bounding_box
+    Grids.get_bounding_sphere
+    Grids.get_geometry_bounding_box
+    Grids.get_world_bounding_box
+    Grids.get_world_bounding_sphere
+    Grids.handle_event
+    Grids.iter
+    Grids.look_at
+    Grids.release_pointer_capture
+    Grids.remove
+    Grids.remove_event_handler
+    Grids.set_pointer_capture
+    Grids.traverse
+
@@ -0,0 +1,74 @@
+.. _api.Ruler:
+
+Ruler
+*****
+
+=====
+Ruler
+=====
+.. currentmodule:: fastplotlib.axes
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: Ruler_api
+
+    Ruler
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: Ruler_api
+
+    Ruler.cast_shadow
+    Ruler.children
+    Ruler.color
+    Ruler.end_pos
+    Ruler.end_value
+    Ruler.geometry
+    Ruler.id
+    Ruler.label
+    Ruler.line
+    Ruler.line_width
+    Ruler.material
+    Ruler.min_tick_distance
+    Ruler.parent
+    Ruler.points
+    Ruler.receive_shadow
+    Ruler.render_mask
+    Ruler.render_order
+    Ruler.start_pos
+    Ruler.start_value
+    Ruler.text
+    Ruler.tick_format
+    Ruler.tick_marker
+    Ruler.tick_side
+    Ruler.tick_size
+    Ruler.ticks
+    Ruler.ticks_at_end_points
+    Ruler.up
+    Ruler.visible
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: Ruler_api
+
+    Ruler.add
+    Ruler.add_event_handler
+    Ruler.clear
+    Ruler.get_bounding_box
+    Ruler.get_bounding_sphere
+    Ruler.get_geometry_bounding_box
+    Ruler.get_world_bounding_box
+    Ruler.get_world_bounding_sphere
+    Ruler.handle_event
+    Ruler.iter
+    Ruler.look_at
+    Ruler.release_pointer_capture
+    Ruler.remove
+    Ruler.remove_event_handler
+    Ruler.set_pointer_capture
+    Ruler.traverse
+    Ruler.update
+
@@ -0,0 +1,10 @@
+Axes
+****
+
+.. toctree::
+    :maxdepth: 1
+
+    Grid
+    Grids
+    Ruler
+    Axes
@@ -22,7 +22,10 @@ Properties
 
     TextureArray.buffer
     TextureArray.col_indices
+    TextureArray.colorspace
+    TextureArray.cpu_buffer
     TextureArray.row_indices
+    TextureArray.shape
     TextureArray.value
 
 Methods

@@ -0,0 +1,39 @@
+.. _api.TextureYUV:
+
+TextureYUV
+**********
+
+==========
+TextureYUV
+==========
+.. currentmodule:: fastplotlib.graphics.features
+
+Constructor
+~~~~~~~~~~~
+.. autosummary::
+    :toctree: TextureYUV_api
+
+    TextureYUV
+
+Properties
+~~~~~~~~~~
+.. autosummary::
+    :toctree: TextureYUV_api
+
+    TextureYUV.colorrange
+    TextureYUV.colorspace
+    TextureYUV.cpu_buffer
+    TextureYUV.texture
+    TextureYUV.value
+
+Methods
+~~~~~~~
+.. autosummary::
+    :toctree: TextureYUV_api
+
+    TextureYUV.add_event_handler
+    TextureYUV.block_events
+    TextureYUV.clear_event_handlers
+    TextureYUV.remove_event_handler
+    TextureYUV.set_value
+
@@ -22,6 +22,8 @@ Graphic Features
     VertexPointSizes
     UniformSize
     TextureArray
+    TextureYUV
+    tuple
     ImageCmap
     ImageVmin
     ImageVmax