From 23ed50fc1028ba30912977fcb4a836c72385fbae Mon Sep 17 00:00:00 2001 From: Polina Nguen <43302774+yavorona@users.noreply.github.com> Date: Fri, 3 Apr 2020 16:16:10 -0400 Subject: [PATCH] Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings to the docs (#246) * 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 Co-authored-by: Polina Nguen --- docs/source/event_builder.rst | 18 ++++++++++++++++++ docs/source/event_dispatcher.rst | 4 ++++ docs/source/index.rst | 10 +++++++++- docs/source/optimizely.rst | 4 ++++ 4 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 docs/source/event_builder.rst create mode 100644 docs/source/event_dispatcher.rst create mode 100644 docs/source/optimizely.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 05bb41e4..80e92ad7 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,6 +4,14 @@ Python SDK .. mdinclude:: ../../README.md +.. toctree:: + :caption: API reference + + optimizely + event_builder + event_dispatcher + + .. toctree:: :caption: Bucketing Algorithm @@ -20,4 +28,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 00000000..c6c7c00b --- /dev/null +++ b/docs/source/optimizely.rst @@ -0,0 +1,4 @@ +Optimizely's APIs +==================== +.. automodule:: optimizely.optimizely + :members: