Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings to the docs (#246)

yavorona · yavorona · commit 5d27ebf0e925 · 2020-05-14T10:49:29.000-07:00
* Added optimizely.py to docs

* Returned to having private methods included for now.

* Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs

Co-authored-by: Polina Nguen &lt;polina.nguen@optimizely.com&gt;
diff --git a/docs/source/event_builder.rst b/docs/source/event_builder.rst
@@ -0,0 +1,18 @@
+Event Builder
+=============
+
+``Event``
+---------
+
+.. autoclass:: optimizely.event_builder.Event
+   :members:
+   :special-members:
+   :private-members:
+
+``EventBuilder``
+----------------
+
+.. autoclass:: optimizely.event_builder.EventBuilder
+   :members:
+   :special-members:
+   :private-members:
diff --git a/docs/source/event_dispatcher.rst b/docs/source/event_dispatcher.rst
@@ -0,0 +1,4 @@
+Event Dispatcher
+================
+.. autoclass:: optimizely.event_dispatcher.EventDispatcher
+   :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -4,6 +4,14 @@ Python SDK
 .. mdinclude:: ../../README.md
 
 
+.. toctree::
+   :caption: API reference
+
+   optimizely
+   event_builder
+   event_dispatcher
+
+
 .. toctree::
    :caption: Bucketing Algorithm
    
@@ -20,4 +28,4 @@ Python SDK
 .. toctree::
    :caption: Help
 
-   contributing
+   contributing
diff --git a/docs/source/optimizely.rst b/docs/source/optimizely.rst
@@ -0,0 +1,4 @@
+Optimizely's APIs
+====================
+.. automodule:: optimizely.optimizely
+   :members: 
