From 15d93f33698ba8ddc852ba50e3a059d835b72ee6 Mon Sep 17 00:00:00 2001 From: Polina Nguen Date: Wed, 1 Apr 2020 18:51:47 -0700 Subject: [PATCH] Add docstrings from config_manager.py and optimizely_config.py to docs Update buckering_algorithm to exclude namedtuble docstrings --- docs/source/bucketing_algorithm.rst | 4 ++-- docs/source/config_manager.rst | 26 ++++++++++++++++++++++++++ docs/source/index.rst | 7 +++++++ docs/source/optimizely_config.rst | 7 +++++++ 4 files changed, 42 insertions(+), 2 deletions(-) create mode 100644 docs/source/config_manager.rst create mode 100644 docs/source/optimizely_config.rst diff --git a/docs/source/bucketing_algorithm.rst b/docs/source/bucketing_algorithm.rst index 6aeabb60..013c0f4d 100644 --- a/docs/source/bucketing_algorithm.rst +++ b/docs/source/bucketing_algorithm.rst @@ -8,7 +8,7 @@ Bucketing Algorithm Methods Decision Service ================ -.. automodule:: optimizely.decision_service +.. autoclass:: optimizely.decision_service.DecisionService :members: :special-members: - :private-members: \ No newline at end of file + :private-members: diff --git a/docs/source/config_manager.rst b/docs/source/config_manager.rst new file mode 100644 index 00000000..05d1efa7 --- /dev/null +++ b/docs/source/config_manager.rst @@ -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: diff --git a/docs/source/index.rst b/docs/source/index.rst index 9ff2b82d..05bb41e4 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -10,6 +10,13 @@ Python SDK bucketing_algorithm +.. toctree:: + :caption: Configuration Data + + config_manager + optimizely_config + + .. toctree:: :caption: Help diff --git a/docs/source/optimizely_config.rst b/docs/source/optimizely_config.rst new file mode 100644 index 00000000..fea102a1 --- /dev/null +++ b/docs/source/optimizely_config.rst @@ -0,0 +1,7 @@ +OptimizelyConfig +================ + +.. automodule:: optimizely.optimizely_config + :members: + :special-members: + :private-members: