From dacb785b58e81299ee03f11b5ceb478f3a262755 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 11:58:05 -0700 Subject: [PATCH 1/3] Added optimizely.py to docs --- docs/source/bucketing_algorithm.rst | 4 ---- docs/source/config_manager.rst | 6 ------ docs/source/index.rst | 8 +++++++- docs/source/optimizely.rst | 4 ++++ 4 files changed, 11 insertions(+), 11 deletions(-) create mode 100644 docs/source/optimizely.rst diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 013c0f4d9..2325522f4 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 05d1efa7d..48cdba0d0 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 05bb41e45..2f392b51f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,6 +4,12 @@ Python SDK .. mdinclude:: ../../README.md +.. toctree:: + :caption: API reference + + optimizely + + .. toctree:: :caption: Bucketing Algorithm @@ -20,4 +26,4 @@ Python SDK .. toctree:: :caption: Help - contributing \ No newline at end of file + contributing diff --git a/docs/source/optimizely.rst b/docs/source/optimizely.rst new file mode 100644 index 000000000..c6c7c00b4 --- /dev/null +++ b/docs/source/optimizely.rst @@ -0,0 +1,4 @@ +Optimizely's APIs +==================== +.. automodule:: optimizely.optimizely + :members: From 37b2f95369d870c2bd8e0e1530c273079067b927 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 12:25:28 -0700 Subject: [PATCH 2/3] 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 2325522f4..013c0f4d9 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 48cdba0d0..05d1efa7d 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 615d4cbd50a21c59b33ddcacfb2fc19dc4f4482a Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Fri, 3 Apr 2020 12:47:02 -0700 Subject: [PATCH 3/3] 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 | 2 ++ 3 files changed, 24 insertions(+) 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 000000000..aa6fa71a4 --- /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 000000000..760842776 --- /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 2f392b51f..80e92ad7f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,6 +8,8 @@ Python SDK :caption: API reference optimizely + event_builder + event_dispatcher .. toctree::