Doc cleanup and quickstart rewrite

Author: einarf

demosys/effects/effect.py

@@ -67,6 +67,8 @@ def __init__(self):
 
     def post_load(self):
         """
+        Override this method if needed when creating an effect.
+
         Called after all effects are initialized before drawing starts.
         Some initialization may be neccessary to do here such as
         interaction with other effects.

docs/index.rst

@@ -8,15 +8,27 @@ A Python 3 cross platform OpenGL 3.3+ core framework based on `ModernGL <https:/
 | |screenshot1|   | |screenshot2|   |
 +-----------------+-----------------+
 
+
+User Guide
+----------
+
+This is the user guide
+
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
-   quickstart
-   settings.rst
-   controls.rst
-   guides/index.rst
-   reference/index.rst
+   user_guide/quickstart
+   user_guide/controls
+   user_guide/index
+
+Reference
+---------
+
+.. toctree::
+   :maxdepth: 1
+
+   reference/effect
+   reference/settings   
 
 
 Indices and tables

docs/quickstart.rst

@@ -1,41 +1,48 @@
-Effect
-======
 
 .. py:module:: demosys.effects
 .. py:currentmodule:: demosys.effects
 
-The base Effect class extended in effect modules.
+Effect
+======
+
+.. autodata:: Effect
+   :annotation:
+
+Initialization
+--------------
+
+.. automethod:: Effect.__init__
+.. automethod:: Effect.post_load
 
 Draw Methods
 ------------
 
-.. automethod:: Effect.draw(time, frametime, target)
-.. automethod:: Effect.post_load()
+.. automethod:: Effect.draw
 
 Resource Methods
 ----------------
 
-.. automethod:: Effect.get_program(label) -> Program
-.. automethod:: Effect.get_texture(label) -> Texture
-.. automethod:: Effect.get_track(name) -> Track
-.. automethod:: Effect.get_scene(label) -> Scene
-.. automethod:: Effect.get_data(label) -> Any
-.. automethod:: Effect.get_effect(label) -> Effect
-.. automethod:: Effect.get_effect_class(effect_name, package_name=None) -> Type[_ForwardRef('Effect')]
+.. automethod:: Effect.get_texture
+.. automethod:: Effect.get_program
+.. automethod:: Effect.get_scene
+.. automethod:: Effect.get_data
+.. automethod:: Effect.get_effect
+.. automethod:: Effect.get_effect_class
+.. automethod:: Effect.get_track
 
 Utility Methods
 ---------------
 
-.. automethod:: Effect.create_projection(fov=75.0, near=1.0, far=100.0, ratio=None)
-.. automethod:: Effect.create_transformation(rotation=None, translation=None)
-.. automethod:: Effect.create_normal_matrix(modelview)
+.. automethod:: Effect.create_projection
+.. automethod:: Effect.create_transformation
+.. automethod:: Effect.create_normal_matrix
 
 Attributes
 ----------
 
+.. autoattribute:: Effect.runnable
 .. autoattribute:: Effect.ctx
+.. autoattribute:: Effect.window
 .. autoattribute:: Effect.sys_camera
 .. autoattribute:: Effect.name
 .. autoattribute:: Effect.label
-.. autoattribute:: Effect.window
-.. autoattribute:: Effect.runnable