Skip to content

Added docstrings from config_manager.py and optimizely_config.py to docs #245

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 1 commit into from
Apr 3, 2020
Merged

Added docstrings from config_manager.py and optimizely_config.py to docs #245

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions docs/source/bucketing_algorithm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Bucketing Algorithm Methods

Decision Service
================
.. automodule:: optimizely.decision_service
.. autoclass:: optimizely.decision_service.DecisionService
:members:
:special-members:
:private-members:
:private-members:
26 changes: 26 additions & 0 deletions docs/source/config_manager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
Config Manager
==============

``Base 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:
7 changes: 7 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ Python SDK
bucketing_algorithm


.. toctree::
:caption: Configuration Data

config_manager
optimizely_config


.. toctree::
:caption: Help

Expand Down
7 changes: 7 additions & 0 deletions docs/source/optimizely_config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
OptimizelyConfig
================

.. automodule:: optimizely.optimizely_config
:members:
:special-members:
:private-members: