From 04958cbede568e6ed36a6d69ac109db99ea4a0f0 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 11:58:05 -0700 Subject: [PATCH 1/5] Added optimizely.py to docs --- docs/source/bucketing_algorithm.rst | 4 ---- docs/source/config_manager.rst | 6 ------ docs/source/index.rst | 4 ++++ docs/source/optimizely.rst | 4 ++++ 4 files changed, 8 insertions(+), 10 deletions(-) create mode 100644 docs/source/optimizely.rst diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 013c0f4d..2325522f 100644 --- a/docs/source/bucketing_algorithm.rst +++ b/docs/source/bucketing_algorithm.rst @@ -2,13 +2,9 @@ Bucketing Algorithm Methods =========================== .. automodule:: optimizely.bucketer :members: - :special-members: - :private-members: Decision Service ================ .. autoclass:: optimizely.decision_service.DecisionService :members: - :special-members: - :private-members: diff --git a/docs/source/config_manager.rst b/docs/source/config_manager.rst index 05d1efa7..48cdba0d 100644 --- a/docs/source/config_manager.rst +++ b/docs/source/config_manager.rst @@ -6,21 +6,15 @@ Config Manager .. autoclass:: optimizely.config_manager.BaseConfigManager :members: - :special-members: - :private-members: ``Static Config Manager`` ------------------------- .. autoclass:: optimizely.config_manager.StaticConfigManager :members: - :special-members: - :private-members: ``Polling Config Manager`` -------------------------- .. autoclass:: optimizely.config_manager.PollingConfigManager :members: - :special-members: - :private-members: diff --git a/docs/source/index.rst b/docs/source/index.rst index ba046b65..81b8ec02 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,7 +7,11 @@ Python SDK .. toctree:: :caption: API reference +<<<<<<< HEAD api_reference +======= + optimizely +>>>>>>> Added optimizely.py to docs .. toctree:: diff --git a/docs/source/optimizely.rst b/docs/source/optimizely.rst new file mode 100644 index 00000000..c6c7c00b --- /dev/null +++ b/docs/source/optimizely.rst @@ -0,0 +1,4 @@ +Optimizely's APIs +==================== +.. automodule:: optimizely.optimizely + :members: From 992fe5547c99c5dead8999c5889a6e6050c64091 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 12:25:28 -0700 Subject: [PATCH 2/5] Returned to having private methods included for now. --- docs/source/bucketing_algorithm.rst | 4 ++++ docs/source/config_manager.rst | 6 ++++++ 2 files changed, 10 insertions(+) diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 2325522f..013c0f4d 100644 --- a/docs/source/bucketing_algorithm.rst +++ b/docs/source/bucketing_algorithm.rst @@ -2,9 +2,13 @@ Bucketing Algorithm Methods =========================== .. automodule:: optimizely.bucketer :members: + :special-members: + :private-members: Decision Service ================ .. autoclass:: optimizely.decision_service.DecisionService :members: + :special-members: + :private-members: diff --git a/docs/source/config_manager.rst b/docs/source/config_manager.rst index 48cdba0d..05d1efa7 100644 --- a/docs/source/config_manager.rst +++ b/docs/source/config_manager.rst @@ -6,15 +6,21 @@ Config Manager .. autoclass:: optimizely.config_manager.BaseConfigManager :members: + :special-members: + :private-members: ``Static Config Manager`` ------------------------- .. autoclass:: optimizely.config_manager.StaticConfigManager :members: + :special-members: + :private-members: ``Polling Config Manager`` -------------------------- .. autoclass:: optimizely.config_manager.PollingConfigManager :members: + :special-members: + :private-members: From 71b5cb3d5aa60de995492b6e1dada7b035a15147 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 12:47:02 -0700 Subject: [PATCH 3/5] Added optimizely.py, event_builder.py, and event_dispatcher.py to the docs --- docs/source/event_builder.rst | 18 ++++++++++++++++++ docs/source/event_dispatcher.rst | 4 ++++ docs/source/index.rst | 4 ---- 3 files changed, 22 insertions(+), 4 deletions(-) create mode 100644 docs/source/event_builder.rst create mode 100644 docs/source/event_dispatcher.rst diff --git a/docs/source/event_builder.rst b/docs/source/event_builder.rst new file mode 100644 index 00000000..aa6fa71a --- /dev/null +++ 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 new file mode 100644 index 00000000..76084277 --- /dev/null +++ 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 index 81b8ec02..ba046b65 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,11 +7,7 @@ Python SDK .. toctree:: :caption: API reference -<<<<<<< HEAD api_reference -======= - optimizely ->>>>>>> Added optimizely.py to docs .. toctree:: From 739c2b5ebcb9dc0f4c3c9403561d793c4ad3e9a1 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Mon, 13 Apr 2020 12:16:35 -0700 Subject: [PATCH 4/5] Add version to docs --- docs/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6b500dd9..89097abf 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -14,11 +14,14 @@ import sys sys.path.insert(0, os.path.abspath('../..')) +from optimizely.version import __version__ + # -- Project information ----------------------------------------------------- project = 'Python SDK' copyright = '2016-2020, Optimizely, Inc' author = 'Optimizely, Inc.' +version = __version__ # The full version, including alpha/beta/rc tags release = '' From 4c3f2b293a21e3420c0f870dee5526ab37413b45 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Mon, 13 Apr 2020 16:31:09 -0700 Subject: [PATCH 5/5] Update branch --- docs/source/event_builder.rst | 18 ------------------ docs/source/event_dispatcher.rst | 4 ---- docs/source/optimizely.rst | 4 ---- 3 files changed, 26 deletions(-) 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/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/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: