Add docstrings from config_manager.py and optimizely_config.py to docs (#245)

yavorona · web-flow · commit 4387cabda85c · 2020-04-03T11:48:50.000-07:00
Update buckering_algorithm to exclude namedtuble docstrings

Co-authored-by: Polina Nguen &lt;polina.nguen@optimizely.com&gt;
diff --git 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:
+   :private-members:
diff --git a/docs/source/config_manager.rst 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
@@ -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
@@ -0,0 +1,7 @@
+OptimizelyConfig
+================
+
+.. automodule:: optimizely.optimizely_config
+   :members:
+   :special-members:
+   :private-members:
