Skip to content

Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings to the docs #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 3, 2020
Merged

Added optimizely.py, event_dispatcher.py, and event_builder.py docstrings to the docs #246

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
dacb785
Added optimizely.py to docs
yavorona Apr 3, 2020
37b2f95
Returned to having private methods included for now.
yavorona Apr 3, 2020
615d4cb
Added optimizely.py, event_builder.py, and event_dispatcher.py to the…
yavorona Apr 3, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/source/event_builder.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:
4 changes: 4 additions & 0 deletions docs/source/event_dispatcher.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Event Dispatcher
================
.. autoclass:: optimizely.event_dispatcher.EventDispatcher
:members:
10 changes: 9 additions & 1 deletion docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Python SDK
.. mdinclude:: ../../README.md


.. toctree::
:caption: API reference

optimizely
event_builder
event_dispatcher


.. toctree::
:caption: Bucketing Algorithm

Expand All @@ -20,4 +28,4 @@ Python SDK
.. toctree::
:caption: Help

contributing
contributing
4 changes: 4 additions & 0 deletions docs/source/optimizely.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Optimizely's APIs
====================
.. automodule:: optimizely.optimizely
:members: