docs: standard usage format across ext packages (#534)

The rendered documentation is a little out of sync in a couple areas. Resolving those. - Adding an API subsection footer to those that don't have it - Removing installation instructions in the readme - Referencing automodule vs a direct include of the readme
open-telemetry · Mar 30, 2020 · 28ee03f · 28ee03f
1 parent a137bc2
commit 28ee03f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 13 deletions.
diff --git a/docs/ext/zipkin/zipkin.rst b/docs/ext/zipkin/zipkin.rst
@@ -1,8 +1,5 @@
-.. include:: ../../../ext/opentelemetry-ext-zipkin/README.rst
-
-
-Module contents
----------------
+Opentelemetry Zipkin Exporter
+=============================
 
 .. automodule:: opentelemetry.ext.zipkin
     :members:

diff --git a/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py b/ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py
@@ -76,6 +76,8 @@
     While testing this library, the aforementioned imprecisions were observed
     to be of *less than a microsecond*.
 
+API
+---
 .. _Floating Point Arithmetic\\: Issues and Limitations:
     https://docs.python.org/3/tutorial/floatingpoint.html
 """

diff --git a/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py b/ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py
@@ -50,6 +50,9 @@ def hello():
 
     application = get_wsgi_application()
     application = OpenTelemetryMiddleware(application)
+
+API
+---
 """
 
 import functools

diff --git a/ext/opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin/__init__.py b/ext/opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin/__init__.py
@@ -15,14 +15,6 @@
 """
 This library allows to export tracing data to `Zipkin <https://zipkin.io/>`_.
 
-Installation
-------------
-
-::
-
-     pip install opentelemetry-ext-zipkin
-
-
 Usage
 -----
-Original file line number
+Diff line change
@@ Expand Up / @@ -50,6 +50,9 @@ def hello(): @@
         application = get_wsgi_application()
         application = OpenTelemetryMiddleware(application)
+    API
+    ---
     """
     import functools
@@ Expand Down @@