Skip to content

Commit b7bbcda

Browse files
authored
Added logger.py and user_profile.py docstrings to the docs. (#247)
* 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 * Added user_profile.py and logger.py docstrings to docs Moved all api_reference components into one rst file Co-authored-by: Polina Nguen <[email protected]>
1 parent 23ed50f commit b7bbcda

File tree

5 files changed

+49
-29
lines changed

5 files changed

+49
-29
lines changed

docs/source/api_reference.rst

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
Optimizely's APIs
2+
=================
3+
.. automodule:: optimizely.optimizely
4+
:members:
5+
6+
7+
Event Builder
8+
=============
9+
10+
``Event``
11+
---------
12+
13+
.. autoclass:: optimizely.event_builder.Event
14+
:members:
15+
16+
``EventBuilder``
17+
----------------
18+
19+
.. autoclass:: optimizely.event_builder.EventBuilder
20+
:members:
21+
22+
23+
Event Dispatcher
24+
================
25+
.. autoclass:: optimizely.event_dispatcher.EventDispatcher
26+
:members:
27+
28+
29+
Logger
30+
======
31+
.. automodule:: optimizely.logger
32+
:members:
33+
34+
35+
User Profile
36+
============
37+
38+
``UserProfile``
39+
---------------
40+
41+
.. autoclass:: optimizely.user_profile.UserProfile
42+
:members:
43+
44+
``UserProfileService``
45+
----------------------
46+
47+
.. autoclass:: optimizely.user_profile.UserProfileService
48+
:members:

docs/source/event_builder.rst

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/source/event_dispatcher.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,7 @@ Python SDK
77
.. toctree::
88
:caption: API reference
99

10-
optimizely
11-
event_builder
12-
event_dispatcher
10+
api_reference
1311

1412

1513
.. toctree::

docs/source/optimizely.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)