Added user_profile.py and logger.py docstrings to docs

Moved all api_reference components into one rst file
optimizely · Apr 7, 2020 · 765d2d8 · 765d2d8
1 parent 572f71c
commit 765d2d8
Show file tree

Hide file tree

Showing 5 changed files with 49 additions and 29 deletions.
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