From 4edb27d9873ef83cd99fa9911fd9094e59fdd2e9 Mon Sep 17 00:00:00 2001 From: Einar Forselv Date: Sun, 4 Aug 2024 21:26:18 +0200 Subject: [PATCH] Restructure GL docs --- doc/api_docs/arcade.rst | 3 --- doc/api_docs/gl/buffer_description.rst | 11 ----------- doc/api_docs/gl/compute_shader.rst | 9 --------- doc/api_docs/gl/context.rst | 6 ++++-- doc/api_docs/gl/framebuffer.rst | 3 --- doc/api_docs/gl/geometry.rst | 21 +++++++++++---------- doc/api_docs/gl/index.rst | 2 -- doc/api_docs/gl/program.rst | 17 +++++++---------- doc/api_docs/gl/texture.rst | 4 ++-- doc/index.rst | 2 +- 10 files changed, 25 insertions(+), 53 deletions(-) delete mode 100644 doc/api_docs/gl/buffer_description.rst delete mode 100644 doc/api_docs/gl/compute_shader.rst diff --git a/doc/api_docs/arcade.rst b/doc/api_docs/arcade.rst index 01b2180f1..6509b2906 100644 --- a/doc/api_docs/arcade.rst +++ b/doc/api_docs/arcade.rst @@ -1,8 +1,5 @@ .. _arcade-api: -API Reference -============= - This page documents the Application Programming Interface (API) for the Python Arcade library. See also: diff --git a/doc/api_docs/gl/buffer_description.rst b/doc/api_docs/gl/buffer_description.rst deleted file mode 100644 index 91985c3a6..000000000 --- a/doc/api_docs/gl/buffer_description.rst +++ /dev/null @@ -1,11 +0,0 @@ - -.. py:currentmodule:: arcade - -BufferDescription -================= - -.. autoclass:: arcade.gl.BufferDescription - :members: - :undoc-members: - :show-inheritance: - :member-order: bysource diff --git a/doc/api_docs/gl/compute_shader.rst b/doc/api_docs/gl/compute_shader.rst deleted file mode 100644 index 634a54b9a..000000000 --- a/doc/api_docs/gl/compute_shader.rst +++ /dev/null @@ -1,9 +0,0 @@ - -ComputeShader -============= - -.. autoclass:: arcade.gl.ComputeShader - :members: - :undoc-members: - :show-inheritance: - :member-order: bysource diff --git a/doc/api_docs/gl/context.rst b/doc/api_docs/gl/context.rst index a7351c0e8..e75491cba 100644 --- a/doc/api_docs/gl/context.rst +++ b/doc/api_docs/gl/context.rst @@ -4,6 +4,8 @@ Context ======= +Context +------- .. autoclass:: arcade.gl.Context :members: @@ -12,14 +14,14 @@ Context :member-order: bysource ContextStats -============ +------------ .. autoclass:: arcade.gl.context.ContextStats :members: :member-order: bysource GLInfo -====== +------ .. autoclass:: arcade.gl.context.GLInfo :members: diff --git a/doc/api_docs/gl/framebuffer.rst b/doc/api_docs/gl/framebuffer.rst index d275df4a8..d61c90359 100644 --- a/doc/api_docs/gl/framebuffer.rst +++ b/doc/api_docs/gl/framebuffer.rst @@ -10,9 +10,6 @@ Framebuffer :show-inheritance: :member-order: bysource -DefaultFrameBuffer -================== - .. autoclass:: arcade.gl.framebuffer.DefaultFrameBuffer :members: :undoc-members: diff --git a/doc/api_docs/gl/geometry.rst b/doc/api_docs/gl/geometry.rst index afba9ab92..a82d992de 100644 --- a/doc/api_docs/gl/geometry.rst +++ b/doc/api_docs/gl/geometry.rst @@ -1,14 +1,6 @@ .. py:currentmodule:: arcade -Geometry Methods -================ - -.. autofunction:: arcade.gl.geometry.quad_2d_fs -.. autofunction:: arcade.gl.geometry.quad_2d -.. autofunction:: arcade.gl.geometry.screen_rectangle -.. autofunction:: arcade.gl.geometry.cube - Geometry ======== @@ -18,11 +10,20 @@ Geometry :show-inheritance: :member-order: bysource -VertexArray -=========== +.. autoclass:: arcade.gl.BufferDescription + :members: + :undoc-members: + :show-inheritance: + :member-order: bysource .. autoclass:: arcade.gl.VertexArray :members: :undoc-members: :show-inheritance: :member-order: bysource + +.. autofunction:: arcade.gl.geometry.quad_2d_fs +.. autofunction:: arcade.gl.geometry.quad_2d +.. autofunction:: arcade.gl.geometry.screen_rectangle +.. autofunction:: arcade.gl.geometry.cube + diff --git a/doc/api_docs/gl/index.rst b/doc/api_docs/gl/index.rst index 5c53deb1b..9b8a26aa6 100644 --- a/doc/api_docs/gl/index.rst +++ b/doc/api_docs/gl/index.rst @@ -41,12 +41,10 @@ directory (git). context texture buffer - buffer_description geometry framebuffer query program - compute_shader utils exceptions diff --git a/doc/api_docs/gl/program.rst b/doc/api_docs/gl/program.rst index ee081478c..15b5a1b1a 100644 --- a/doc/api_docs/gl/program.rst +++ b/doc/api_docs/gl/program.rst @@ -1,8 +1,8 @@ .. py:currentmodule:: arcade -Program -======= +Shader / Program +================ .. autoclass:: arcade.gl.Program :members: @@ -10,8 +10,11 @@ Program :show-inheritance: :member-order: bysource -Uniform -======= +.. autoclass:: arcade.gl.ComputeShader + :members: + :undoc-members: + :show-inheritance: + :member-order: bysource .. autoclass:: arcade.gl.uniform.Uniform :members: @@ -19,18 +22,12 @@ Uniform :show-inheritance: :member-order: bysource -UniformBlock -============ - .. autoclass:: arcade.gl.uniform.UniformBlock :members: :undoc-members: :show-inheritance: :member-order: bysource -ShaderSource -============ - .. autoclass:: arcade.gl.glsl.ShaderSource :members: :undoc-members: diff --git a/doc/api_docs/gl/texture.rst b/doc/api_docs/gl/texture.rst index 4c89fd1a4..68f36e652 100644 --- a/doc/api_docs/gl/texture.rst +++ b/doc/api_docs/gl/texture.rst @@ -1,8 +1,8 @@ .. py:currentmodule:: arcade -Texture2D -========= +Texture +======= .. autoclass:: arcade.gl.Texture2D :members: diff --git a/doc/index.rst b/doc/index.rst index 9aff226d1..c23d2030f 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -132,7 +132,7 @@ Arcade is developed by volunteers. :caption: API Reference api_docs/quick_index - Reference + api_docs/arcade .. Indices and tables