Skip to content

Flatten API Reference #2337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 4, 2024
Merged

Flatten API Reference #2337

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions doc/api_docs/arcade.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.. _arcade-api:

API Reference
=============

This page documents the Application Programming Interface (API)
for the Python Arcade library. See also:

Expand Down
11 changes: 0 additions & 11 deletions doc/api_docs/gl/buffer_description.rst
View file
Open in desktop

This file was deleted.

9 changes: 0 additions & 9 deletions doc/api_docs/gl/compute_shader.rst
View file
Open in desktop

This file was deleted.

6 changes: 4 additions & 2 deletions doc/api_docs/gl/context.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
Context
=======

Context
-------

.. autoclass:: arcade.gl.Context
:members:
Expand All @@ -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:
Expand Down
3 changes: 0 additions & 3 deletions doc/api_docs/gl/framebuffer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,6 @@ Framebuffer
:show-inheritance:
:member-order: bysource

DefaultFrameBuffer
==================

.. autoclass:: arcade.gl.framebuffer.DefaultFrameBuffer
:members:
:undoc-members:
Expand Down
21 changes: 11 additions & 10 deletions doc/api_docs/gl/geometry.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
========

Expand All @@ -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

2 changes: 0 additions & 2 deletions doc/api_docs/gl/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,10 @@ directory (git).
context
texture
buffer
buffer_description
geometry
framebuffer
query
program
compute_shader
utils
exceptions

Expand Down
17 changes: 7 additions & 10 deletions doc/api_docs/gl/program.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
4 changes: 2 additions & 2 deletions doc/api_docs/gl/texture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

.. py:currentmodule:: arcade

Texture2D
=========
Texture
=======

.. autoclass:: arcade.gl.Texture2D
:members:
Expand Down
2 changes: 1 addition & 1 deletion doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down