Config module doc fixes (#487)

Add the new configuration module from #466 to the generated docs. Co-authored-by: Diego Hurtado <[email protected]> Co-authored-by: Mauricio Vásquez <[email protected]>
open-telemetry · Mar 14, 2020 · 71c0c83 · 71c0c83
1 parent 4f1aa28
commit 71c0c83
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 20 deletions.
diff --git a/docs/api/api.rst b/docs/api/api.rst
@@ -6,6 +6,7 @@ OpenTelemetry Python API
 .. toctree::
     :maxdepth: 1
 
+    configuration
     context
     metrics
     trace
diff --git a/docs/api/configuration.rst b/docs/api/configuration.rst
@@ -0,0 +1,10 @@
+opentelemetry.configuration module
+==================================
+
+Module contents
+---------------
+
+.. automodule:: opentelemetry.configuration
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/opentelemetry-api/src/opentelemetry/configuration/__init__.py b/opentelemetry-api/src/opentelemetry/configuration/__init__.py
@@ -19,30 +19,31 @@
 Simple configuration manager
 
 This is a configuration manager for the Tracer and Meter providers. It reads
-configuration from environment variables prefixed with OPENTELEMETRY_PYTHON_:
+configuration from environment variables prefixed with
+``OPENTELEMETRY_PYTHON_``:
 
-1. OPENTELEMETRY_PYTHON_TRACER_PROVIDER
-2. OPENTELEMETRY_PYTHON_METER_PROVIDER
+1. ``OPENTELEMETRY_PYTHON_TRACER_PROVIDER``
+2. ``OPENTELEMETRY_PYTHON_METER_PROVIDER``
 
 The value of these environment variables should be the name of the entry point
 that points to the class that implements either provider. This OpenTelemetry
 API package provides one entry point for each, which can be found in the
-setup.py file:
-
-entry_points={
-    ...
-    "opentelemetry_meter_provider": [
-        "default_meter_provider = "
-        "opentelemetry.metrics:DefaultMeterProvider"
-    ],
-    "opentelemetry_tracer_provider": [
-        "default_tracer_provider = "
-        "opentelemetry.trace:DefaultTracerProvider"
-    ],
-}
+setup.py file::
+
+    entry_points={
+        ...
+        "opentelemetry_meter_provider": [
+            "default_meter_provider = "
+            "opentelemetry.metrics:DefaultMeterProvider"
+        ],
+        "opentelemetry_tracer_provider": [
+            "default_tracer_provider = "
+            "opentelemetry.trace:DefaultTracerProvider"
+        ],
+    }
 
 To use the meter provider above, then the
-OPENTELEMETRY_PYTHON_METER_PROVIDER should be set to
+``OPENTELEMETRY_PYTHON_METER_PROVIDER`` should be set to
 "default_meter_provider" (this is not actually necessary since the
 OpenTelemetry API provided providers are the default ones used if no
 configuration is found in the environment variables).
@@ -52,11 +53,12 @@
 be instantiated as many times as needed without concern because it will
 always produce the same instance. Its attributes are lazy loaded and they
 hold an instance of their corresponding provider. So, for example, to get
-the configured meter provider:
+the configured meter provider::
 
-from opentelemetry.configuration import Configuration
+    from opentelemetry.configuration import Configuration
+
+    tracer_provider = Configuration().tracer_provider
 
-tracer_provider = Configuration().tracer_provider
 """
 
 from logging import getLogger