Restructure context documentation

moderngl · Nov 29, 2024 · fc6be94 · fc6be94
1 parent 2e71480
commit fc6be94
Show file tree

Hide file tree

Showing 15 changed files with 136 additions and 760 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,6 +43,12 @@ def __getattr__(cls: Any, name: Any) -> MagicMock:
     "pywavefront",
     "pywavefront.obj",
     "trimesh",
+    "pygame",
+    "pygame._sdl2",
+    "pygame.display",
+    "pygame.event",
+    "pyopengltk",
+    "pyopengltk.OpenGLFrame",
 ]
 
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

diff --git a/docs/reference/context/backends.rst b/docs/reference/context/backends.rst
@@ -0,0 +1,74 @@
+
+.. py:module:: moderngl_window
+.. py:currentmodule:: moderngl_window
+
+
+Window Backends
+===============
+
+pyglet
+------
+
+.. autoclass:: moderngl_window.context.pyglet.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+glfw
+----
+
+.. autoclass:: moderngl_window.context.glfw.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+sdl2
+----
+
+.. autoclass:: moderngl_window.context.sdl2.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+
+pygame
+------
+
+.. autoclass:: moderngl_window.context.pygame2.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+
+Pyside2
+-------
+
+.. autoclass:: moderngl_window.context.pyside2.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+
+PyQt5
+-----
+
+.. autoclass:: moderngl_window.context.pyqt5.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+tkinter
+-------
+
+.. autoclass:: moderngl_window.context.tk.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+headless
+--------
+
+.. autoclass:: moderngl_window.context.headless.window.Window
+   :members:
+   :inherited-members:
+   :show-inheritance:
diff --git a/docs/reference/context/base.rst b/docs/reference/context/base.rst
@@ -0,0 +1,15 @@
+
+.. py:module:: moderngl_window.context.base.window
+.. py:currentmodule:: moderngl_window.context.base.window
+
+
+.. autoclass:: WindowConfig
+    :members:
+    :inherited-members:
+    :show-inheritance:
+
+
+.. autoclass:: BaseWindow
+    :members:
+    :inherited-members:
+    :show-inheritance:
diff --git a/docs/reference/context/basewindow.rst b/docs/reference/context/basewindow.rst
diff --git a/docs/reference/context/glfw.window.rst b/docs/reference/context/glfw.window.rst
diff --git a/docs/reference/context/headless.window.rst b/docs/reference/context/headless.window.rst
diff --git a/docs/reference/context/index.rst b/docs/reference/context/index.rst
@@ -5,11 +5,5 @@ moderngl_window.context
 .. toctree::
    :maxdepth: 2
 
-   windowconfig
-   basewindow
-   glfw.window
-   headless.window
-   pyglet.window
-   pyqt5.window
-   pyside2.window
-   sdl2.window
+   base
+   backends