Skip to content

Added logger.py and user_profile.py docstrings to the docs. #247

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.

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 5 commits into from
Apr 7, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
48 changes: 48 additions & 0 deletions docs/source/api_reference.rst
Original file line number Diff line number Diff line change
@@ -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:
18 changes: 0 additions & 18 deletions docs/source/event_builder.rst

This file was deleted.

4 changes: 0 additions & 4 deletions docs/source/event_dispatcher.rst

This file was deleted.

4 changes: 1 addition & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ Python SDK
.. toctree::
:caption: API reference

optimizely
event_builder
event_dispatcher
api_reference


.. toctree::
Expand Down
4 changes: 0 additions & 4 deletions docs/source/optimizely.rst

This file was deleted.