Added logger.py and user_profile.py docstrings to the docs. (#247)

* 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 * Added user_profile.py and logger.py docstrings to docs Moved all api_reference components into one rst file Co-authored-by: Polina Nguen <polina.nguen@optimizely.com>
optimizely · yavorona · May 14, 2020 · Mar 27, 2020 · Mar 29, 2020 · Mar 30, 2020
commit a2ce5958b1036182b60e28d7a025653d3885d760
diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst
@@ -0,0 +1,48 @@
+Optimizely's APIs
+=================
+.. automodule:: optimizely.optimizely
+   :members: 
+
+
+Event Builder
+=============
+
+``Event``
+---------
+
+.. autoclass:: optimizely.event_builder.Event
+   :members:
+
+``EventBuilder``
+----------------
+
+.. autoclass:: optimizely.event_builder.EventBuilder
+   :members:
+
+
+Event Dispatcher
+================
+.. autoclass:: optimizely.event_dispatcher.EventDispatcher
+   :members:
+
+
+Logger
+======
+.. automodule:: optimizely.logger
+   :members:
+
+
+User Profile
+============
+
+``UserProfile``
+---------------
+
+.. autoclass:: optimizely.user_profile.UserProfile
+   :members:
+
+``UserProfileService``
+----------------------
+
+.. autoclass:: optimizely.user_profile.UserProfileService
+   :members:
diff --git a/docs/source/event_builder.rst b/docs/source/event_builder.rst
diff --git a/docs/source/event_dispatcher.rst b/docs/source/event_dispatcher.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -7,9 +7,7 @@ Python SDK
 .. toctree::
    :caption: API reference
 
-   optimizely
-   event_builder
-   event_dispatcher
+   api_reference
 
 
 .. toctree::

diff --git a/docs/source/optimizely.rst b/docs/source/optimizely.rst