Merge #471

471: Docs sprites r=astronouth7303 a=pathunstrom Co-authored-by: Piper Thunstrom <pathunstrom@gmail.com>
ppb · May 22, 2020 · 0525ffa · 0525ffa
2 parents c4199f3 + 4dbcac9
commit 0525ffa
Show file tree

Hide file tree

Showing 3 changed files with 172 additions and 47 deletions.
diff --git a/docs/reference/assets.rst b/docs/reference/assets.rst
@@ -1,4 +1,4 @@
-.. py:currentmodule:: ppb.assets
+.. py:module:: ppb.assets
 
 Assets
 ======

diff --git a/docs/reference/sprites.rst b/docs/reference/sprites.rst
@@ -1,24 +1,27 @@
-.. py:currentmodule:: ppb.sprites
+.. py:module:: ppb.sprites
 
 =================
-All About Sprites
+Sprites
 =================
 
 .. automodule:: ppb.sprites
+   :noindex:
 
 ------------------
-Default Sprite
+Concrete Sprites
 ------------------
 
-This is the class you should instantiate or subclass for your games unless
-you are changing the defaults.
+Concrete sprites are a combination of :class:`BaseSprite` and various mixins.
+They implement a number of useful features for game development and should be
+the primary classes you subclass when building game objects.
 
 .. autoclass:: ppb.Sprite
    :members:
    :inherited-members:
 
-Note that ``ppb.BaseSprite`` is deprecated in favor of ppb.Sprite. Scheduled
-for removal in ppb v0.8.0.
+.. autoclass:: ppb.sprites.RectangleSprite
+   :members:
+   :inherited-members:
 
 -------------------
 Feature Mixins
@@ -33,6 +36,9 @@ complete documentation.
 .. autoclass:: ppb.sprites.RotatableMixin
    :members:
 
+.. autoclass:: ppb.sprites.RectangleShapeMixin
+   :members:
+
 .. autoclass:: ppb.sprites.SquareShapeMixin
    :members:
 
@@ -46,13 +52,3 @@ expectations.
 .. autoclass:: ppb.sprites.BaseSprite
    :members:
    :inherited-members:
-
-
--------------------
-Internals
--------------------
-
-These classes are internals for various APIs included with mixins.
-
-.. autoclass:: ppb.sprites.Side
-   :members: