Merge pull request #5 from pygfx/docs

Add docs

Author: almarklein

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

@@ -0,0 +1,14 @@
+rendercanvas base classes
+=========================
+
+.. autoclass:: rendercanvas.base.WgpuCanvasInterface
+    :members:
+
+.. autoclass:: rendercanvas.base.WgpuCanvasBase
+    :members:
+
+.. .. autoclass:: rendercanvas.base.WgpuLoop
+..     :members:
+
+.. .. autoclass:: rendercanvas.base.WgpuTimer
+..     :members:

docs/conf.py

@@ -0,0 +1,75 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+
+import os
+import sys
+import shutil
+
+
+ROOT_DIR = os.path.abspath(os.path.join(__file__, "..", ".."))
+sys.path.insert(0, ROOT_DIR)
+
+os.environ["WGPU_FORCE_OFFSCREEN"] = "true"
+
+
+# Load wglibu so autodoc can query docstrings
+import rendercanvas  # noqa: E402
+
+
+# -- Project information -----------------------------------------------------
+
+project = "rendercanvas"
+copyright = "2020-2024, Almar Klein, Korijn van Golen"
+author = "Almar Klein, Korijn van Golen"
+release = rendercanvas.__version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_rtd_theme",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "wgpu": ("https://wgpu-py.readthedocs.io/en/latest", None),
+}
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+master_doc = "index"
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []

docs/gui.rst

@@ -0,0 +1,200 @@
+gui API
+=======
+
+.. currentmodule:: rendercanvas
+
+You can use vanilla wgpu for compute tasks and to render offscreen. To
+render to a window on screen we need a *canvas*. Since the Python
+ecosystem provides many different GUI toolkits, rendercanvas implements a base
+canvas class, and has builtin support for a few GUI toolkits. At the
+moment these include GLFW, Jupyter, Qt, and wx.
+
+
+The Canvas base classes
+-----------------------
+
+For each supported GUI toolkit there is a module that implements a ``WgpuCanvas`` class,
+which inherits from :class:`WgpuCanvasBase`, providing a common API.
+The GLFW, Qt, and Jupyter backends also inherit from  :class:`WgpuAutoGui` to include
+support for events (interactivity). In the next sections we demonstrates the different
+canvas classes that you can use.
+
+
+The auto GUI backend
+--------------------
+
+Generally the best approach for examples and small applications is to use the
+automatically selected GUI backend. This ensures that the code is portable
+across different machines and environments. Using ``rendercanvas.auto`` selects a
+suitable backend depending on the environment and more. See
+:ref:`interactive_use` for details.
+
+To implement interaction, the ``canvas`` has a :func:`WgpuAutoGui.handle_event()` method
+that can be overloaded. Alternatively you can use it's :func:`WgpuAutoGui.add_event_handler()`
+method. See the `event spec <https://jupyter-rfb.readthedocs.io/en/stable/events.html>`_
+for details about the event objects.
+
+
+.. code-block:: py
+
+    from wgpu.gui.auto import WgpuCanvas, run, call_later
+
+    canvas = WgpuCanvas(title="Example")
+    canvas.request_draw(your_draw_function)
+
+    run()
+
+
+Support for GLFW
+----------------
+
+`GLFW <https://github.com/FlorianRhiem/pyGLFW>`_ is a lightweight windowing toolkit.
+Install it with ``pip install glfw``. The preferred approach is to use the auto backend,
+but you can replace ``from rendercanvas.auto`` with ``from rendercanvas.glfw`` to force using GLFW.
+
+.. code-block:: py
+
+    from wgpu.gui.glfw import WgpuCanvas, run, call_later
+
+    canvas = WgpuCanvas(title="Example")
+    canvas.request_draw(your_draw_function)
+
+    run()
+
+
+Support for Qt
+--------------
+
+There is support for PyQt5, PyQt6, PySide2 and PySide6. The rendercanvas library detects what
+library you are using by looking what module has been imported.
+For a toplevel widget, the ``rendercanvas.qt.WgpuCanvas`` class can be imported. If you want to
+embed the canvas as a subwidget, use ``rendercanvas.qt.WgpuWidget`` instead.
+
+Also see the `Qt triangle example <https://github.com/pygfx/wgpu-py/blob/main/examples/triangle_qt.py>`_
+and `Qt triangle embed example <https://github.com/pygfx/wgpu-py/blob/main/examples/triangle_qt_embed.py>`_.
+
+.. code-block:: py
+
+    # Import any of the Qt libraries before importing the WgpuCanvas.
+    # This way wgpu knows which Qt library to use.
+    from PySide6 import QtWidgets
+    from wgpu.gui.qt import WgpuCanvas
+
+    app = QtWidgets.QApplication([])
+
+    # Instantiate the canvas
+    canvas = WgpuCanvas(title="Example")
+
+    # Tell the canvas what drawing function to call
+    canvas.request_draw(your_draw_function)
+
+    app.exec_()
+
+
+Support for wx
+--------------
+
+There is support for embedding a wgpu visualization in wxPython.
+For a toplevel widget, the ``gui.wx.WgpuCanvas`` class can be imported. If you want to
+embed the canvas as a subwidget, use ``gui.wx.WgpuWidget`` instead.
+
+Also see the `wx triangle example <https://github.com/pygfx/wgpu-py/blob/main/examples/triangle_wx.py>`_
+and `wx triangle embed example <https://github.com/pygfx/wgpu-py/blob/main/examples/triangle_wx_embed.py>`_.
+
+.. code-block:: py
+
+    import wx
+    from wgpu.gui.wx import WgpuCanvas
+
+    app = wx.App()
+
+    # Instantiate the canvas
+    canvas = WgpuCanvas(title="Example")
+
+    # Tell the canvas what drawing function to call
+    canvas.request_draw(your_draw_function)
+
+    app.MainLoop()
+
+
+
+Support for offscreen
+---------------------
+
+You can also use a "fake" canvas to draw offscreen and get the result as a numpy array.
+Note that you can render to a texture without using any canvas
+object, but in some cases it's convenient to do so with a canvas-like API.
+
+.. code-block:: py
+
+    from wgpu.gui.offscreen import WgpuCanvas
+
+    # Instantiate the canvas
+    canvas = WgpuCanvas(size=(500, 400), pixel_ratio=1)
+
+    # ...
+
+    # Tell the canvas what drawing function to call
+    canvas.request_draw(your_draw_function)
+
+    # Perform a draw
+    array = canvas.draw()  # numpy array with shape (400, 500, 4)
+
+
+Support for Jupyter lab and notebook
+------------------------------------
+
+WGPU can be used in Jupyter lab and the Jupyter notebook. This canvas
+is based on `jupyter_rfb <https://github.com/vispy/jupyter_rfb>`_, an ipywidget
+subclass implementing a remote frame-buffer. There are also some `wgpu examples <https://jupyter-rfb.readthedocs.io/en/stable/examples/>`_.
+
+.. code-block:: py
+
+    # from wgpu.gui.jupyter import WgpuCanvas  # Direct approach
+    from wgpu.gui.auto import WgpuCanvas  # Approach compatible with desktop usage
+
+    canvas = WgpuCanvas()
+
+    # ... wgpu code
+
+    canvas  # Use as cell output
+
+
+.. _interactive_use:
+
+Using a canvas interactively
+----------------------------
+
+The rendercanvas gui's are designed to support interactive use. Firstly, this is
+realized by automatically selecting the appropriate GUI backend. Secondly, the
+``run()`` function (which normally enters the event-loop) does nothing in an
+interactive session.
+
+Many interactive environments have some sort of GUI support, allowing the repl
+to stay active (i.e. you can run new code), while the GUI windows is also alive.
+In rendercanvas we try to select the GUI that matches the current environment.
+
+On ``jupyter notebook`` and ``jupyter lab`` the jupyter backend (i.e.
+``jupyter_rfb``) is normally selected. When you are using ``%gui qt``, rendercanvas will
+honor that and use Qt instead.
+
+On ``jupyter console`` and ``qtconsole``, the kernel is the same as in ``jupyter notebook``,
+making it (about) impossible to tell that we cannot actually use
+ipywidgets. So it will try to use ``jupyter_rfb``, but cannot render anything.
+It's theefore advised to either use ``%gui qt`` or set the ``WGPU_GUI_BACKEND`` env var
+to "glfw". The latter option works well, because these kernels *do* have a
+running asyncio event loop!
+
+On other environments that have a running ``asyncio`` loop, the glfw backend is
+preferred. E.g on ``ptpython --asyncio``.
+
+On IPython (the old-school terminal app) it's advised to use ``%gui qt`` (or
+``--gui qt``). It seems not possible to have a running asyncio loop here.
+
+On IDE's like Spyder or Pyzo, rendercanvas detects the integrated GUI, running on
+glfw if asyncio is enabled or Qt if a qt app is running.
+
+On an interactive session without GUI support, one must call ``run()`` to make
+the canvases interactive. This enters the main loop, which prevents entering new
+code. Once all canvases are closed, the loop returns. If you make new canvases
+afterwards, you can call ``run()`` again. This is similar to ``plt.show()`` in Matplotlib.