Doc fixes (#206)

* gitatttributes

* Minor doc fixes

* make.py: run tests

* use automodule from moderngl_window

* Restructure context documentation

* screenshot

* geometry

* Missing __init__.py files

* loaders

* finders

* meta

* opengl

* resources

* scene

* timers

* utils

* Remove doc test

* Disable doctests in actions

.gitatttributes

@@ -0,0 +1,25 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout.
+*.py text diff=python
+*.txt text
+*.rst text
+*.md text
+Makefile text
+makefile text
+
+# Declare files that will always have CRLF line endings on checkout.
+*.bat text eol=crlf
+
+# Denote all files that are truly binary and should not be modified.
+*.png binary
+*.jpg binary
+*.ttf binary
+*.mp3 binary
+*.gif binary
+*.wav binary
+*.gltf binary
+*.glb binary
+*.obj binary

.github/workflows/lint.yml

@@ -27,7 +27,7 @@ jobs:
       - name: Lint with ruff
         run: |
           ruff check
-      - name: Test with pytest
-        run: |
-          # TODO: Figure out if we can run headless tests
-          pytest tests/test_docs.py
+      # - name: Test with pytest
+      #   run: |
+      #     # TODO: Figure out if we can run headless tests
+      #     pytest tests/test_docs.py

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)

docs/guide/resource_system.rst

@@ -137,7 +137,7 @@ Textures
     textures.load(TextureDescription(path='wood.png', flip=True, mipmap=True, anisotropy=16.0))
 
     # Load a texture array containing 10 vertically stacked tile textures
-    textures.load(TextureDescription(path='tiles.png', layers=10, mipmap=True, anisotrpy=8.0))
+    textures.load(TextureDescription(path='tiles.png', layers=10, mipmap=True, anisotropy=8.0))
 
 Programs
 ~~~~~~~~

docs/index.rst

@@ -9,9 +9,9 @@ Welcome to moderngl-window's documentation!
 A cross platform helper library for ModernGL making window
 creation and resource loading simple.
 
-.. Note:: Please report documentation improvements/issues on github. 
-   
-   Writing documentation is difficult and we can't do it without you. 
+.. Note:: Please report documentation improvements/issues on github.
+
+   Writing documentation is difficult and we can't do it without you.
    Pull requests with documentation improvements are also greatly appreciated.
 
 .. toctree::
@@ -33,14 +33,14 @@ creation and resource loading simple.
    reference/screenshot.rst
    reference/context/index
    reference/geometry
-   reference/loaders/index
-   reference/meta/index
-   reference/finders/index
+   reference/loaders
+   reference/meta
+   reference/finders
    reference/opengl/index
-   reference/resources/index
-   reference/timers/index
+   reference/resources
+   reference/timers
    reference/utils/index
-   reference/scene/index
+   reference/scene
 
 
 Indices and tables

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:

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: