From 3fa1aadf14afdf6b901d9586917a6086f8771738 Mon Sep 17 00:00:00 2001 From: Einar Forselv Date: Sat, 30 Nov 2024 00:30:11 +0100 Subject: [PATCH] finders --- docs/index.rst | 2 +- docs/reference/finders.rst | 34 ++++++++++++++++++++++++++++++ docs/reference/finders/base.rst | 20 ------------------ docs/reference/finders/data.rst | 20 ------------------ docs/reference/finders/index.rst | 12 ----------- docs/reference/finders/program.rst | 20 ------------------ docs/reference/finders/scene.rst | 20 ------------------ docs/reference/finders/texture.rst | 20 ------------------ 8 files changed, 35 insertions(+), 113 deletions(-) create mode 100644 docs/reference/finders.rst delete mode 100644 docs/reference/finders/base.rst delete mode 100644 docs/reference/finders/data.rst delete mode 100644 docs/reference/finders/index.rst delete mode 100644 docs/reference/finders/program.rst delete mode 100644 docs/reference/finders/scene.rst delete mode 100644 docs/reference/finders/texture.rst diff --git a/docs/index.rst b/docs/index.rst index 7e005a37..3209bd50 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -35,7 +35,7 @@ creation and resource loading simple. reference/geometry reference/loaders reference/meta/index - reference/finders/index + reference/finders reference/opengl/index reference/resources/index reference/timers/index diff --git a/docs/reference/finders.rst b/docs/reference/finders.rst new file mode 100644 index 00000000..d89a2e0d --- /dev/null +++ b/docs/reference/finders.rst @@ -0,0 +1,34 @@ + +.. py:module:: moderngl_window +.. py:currentmodule:: moderngl_window + + +moderngl_window.finders +======================= + +.. autoclass:: moderngl_window.finders.base.BaseFilesystemFinder + :members: + +Data +---- + +.. autoclass:: moderngl_window.finders.data.FilesystemFinder + :members: + +Program +------- + +.. autoclass:: moderngl_window.finders.program.FilesystemFinder + :members: + +Scene +----- + +.. autoclass:: moderngl_window.finders.scene.FilesystemFinder + :members: + +Texture +------- + +.. autoclass:: moderngl_window.finders.texture.FilesystemFinder + :members: diff --git a/docs/reference/finders/base.rst b/docs/reference/finders/base.rst deleted file mode 100644 index d8253f58..00000000 --- a/docs/reference/finders/base.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. py:module:: moderngl_window.finders.base -.. py:currentmodule:: moderngl_window.finders.base - -base.BaseFilesystemFinder -========================= - -.. autodata:: BaseFilesystemFinder - :annotation: - -Methods -------- - -.. automethod:: BaseFilesystemFinder.__init__ -.. automethod:: BaseFilesystemFinder.find - -Attributes ----------- - -.. autoattribute:: BaseFilesystemFinder.settings_attr diff --git a/docs/reference/finders/data.rst b/docs/reference/finders/data.rst deleted file mode 100644 index 9aedafb3..00000000 --- a/docs/reference/finders/data.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. py:module:: moderngl_window.finders.data -.. py:currentmodule:: moderngl_window.finders.data - -data.FilesystemFinder -===================== - -.. autodata:: FilesystemFinder - :annotation: - -Methods -------- - -.. automethod:: FilesystemFinder.__init__ -.. automethod:: FilesystemFinder.find - -Attributes ----------- - -.. autoattribute:: FilesystemFinder.settings_attr diff --git a/docs/reference/finders/index.rst b/docs/reference/finders/index.rst deleted file mode 100644 index 01874293..00000000 --- a/docs/reference/finders/index.rst +++ /dev/null @@ -1,12 +0,0 @@ - -moderngl_window.finders -======================= - -.. toctree:: - :maxdepth: 2 - - base - texture - program - scene - data diff --git a/docs/reference/finders/program.rst b/docs/reference/finders/program.rst deleted file mode 100644 index 62d7b594..00000000 --- a/docs/reference/finders/program.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. py:module:: moderngl_window.finders.program -.. py:currentmodule:: moderngl_window.finders.program - -program.FilesystemFinder -======================== - -.. autodata:: FilesystemFinder - :annotation: - -Methods -------- - -.. automethod:: FilesystemFinder.__init__ -.. automethod:: FilesystemFinder.find - -Attributes ----------- - -.. autoattribute:: FilesystemFinder.settings_attr diff --git a/docs/reference/finders/scene.rst b/docs/reference/finders/scene.rst deleted file mode 100644 index 95410d3c..00000000 --- a/docs/reference/finders/scene.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. py:module:: moderngl_window.finders.scene -.. py:currentmodule:: moderngl_window.finders.scene - -scene.FilesystemFinder -====================== - -.. autodata:: FilesystemFinder - :annotation: - -Methods -------- - -.. automethod:: FilesystemFinder.__init__ -.. automethod:: FilesystemFinder.find - -Attributes ----------- - -.. autoattribute:: FilesystemFinder.settings_attr diff --git a/docs/reference/finders/texture.rst b/docs/reference/finders/texture.rst deleted file mode 100644 index 8f02b96c..00000000 --- a/docs/reference/finders/texture.rst +++ /dev/null @@ -1,20 +0,0 @@ - -.. py:module:: moderngl_window.finders.texture -.. py:currentmodule:: moderngl_window.finders.texture - -texture.FilesystemFinder -======================== - -.. autodata:: FilesystemFinder - :annotation: - -Methods -------- - -.. automethod:: FilesystemFinder.__init__ -.. automethod:: FilesystemFinder.find - -Attributes ----------- - -.. autoattribute:: FilesystemFinder.settings_attr