From 765d2d88cf329d8a3681a1038f064881c8677b70 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Mon, 6 Apr 2020 17:31:43 -0700 Subject: [PATCH] Added user_profile.py and logger.py docstrings to docs Moved all api_reference components into one rst file --- docs/source/api_reference.rst | 48 ++++++++++++++++++++++++++++++++ docs/source/event_builder.rst | 18 ------------ docs/source/event_dispatcher.rst | 4 --- docs/source/index.rst | 4 +-- docs/source/optimizely.rst | 4 --- 5 files changed, 49 insertions(+), 29 deletions(-) create mode 100644 docs/source/api_reference.rst delete mode 100644 docs/source/event_builder.rst delete mode 100644 docs/source/event_dispatcher.rst delete mode 100644 docs/source/optimizely.rst diff --git a/docs/source/api_reference.rst b/docs/source/api_reference.rst new file mode 100644 index 00000000..6f3a60bf --- /dev/null +++ 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 deleted file mode 100644 index aa6fa71a..00000000 --- a/docs/source/event_builder.rst +++ /dev/null @@ -1,18 +0,0 @@ -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 deleted file mode 100644 index 76084277..00000000 --- a/docs/source/event_dispatcher.rst +++ /dev/null @@ -1,4 +0,0 @@ -Event Dispatcher -================ -.. autoclass:: optimizely.event_dispatcher.EventDispatcher - :members: diff --git a/docs/source/index.rst b/docs/source/index.rst index 80e92ad7..ba046b65 100644 --- 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 deleted file mode 100644 index c6c7c00b..00000000 --- a/docs/source/optimizely.rst +++ /dev/null @@ -1,4 +0,0 @@ -Optimizely's APIs -==================== -.. automodule:: optimizely.optimizely - :members: