Restructure GL docs (#2337)

einarf · web-flow · commit 4d89e32ddb04 · 2024-08-04T21:52:28.000+02:00
diff --git 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
diff --git a/doc/api_docs/gl/compute_shader.rst b/doc/api_docs/gl/compute_shader.rst
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -1,36 +1,33 @@
 
 .. py:currentmodule:: arcade
 
-Program
-=======
+Shader / Program
+================
 
 .. autoclass:: arcade.gl.Program
    :members:
    :undoc-members:
    :show-inheritance:
    :member-order: bysource
 
-Uniform
-=======
+.. autoclass:: arcade.gl.ComputeShader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+   :member-order: bysource
 
 .. autoclass:: arcade.gl.uniform.Uniform
    :members:
    :undoc-members:
    :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
@@ -1,8 +1,8 @@
 
 .. py:currentmodule:: arcade
 
-Texture2D
-=========
+Texture
+=======
 
 .. autoclass:: arcade.gl.Texture2D
    :members:
diff --git 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>
+   api_docs/arcade
 
 
 .. Indices and tables
