Skip to content

Commit 28ee03f

Browse files
authored
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
1 parent a137bc2 commit 28ee03f

File tree

4 files changed

+7
-13
lines changed
  • docs/ext/zipkin
  • ext
    • opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim
    • opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi
    • opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin

4 files changed

+7
-13
lines changed

docs/ext/zipkin/zipkin.rst

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
1-
.. include:: ../../../ext/opentelemetry-ext-zipkin/README.rst
2-
3-
4-
Module contents
5-
---------------
1+
Opentelemetry Zipkin Exporter
2+
=============================
63

74
.. automodule:: opentelemetry.ext.zipkin
85
:members:

ext/opentelemetry-ext-opentracing-shim/src/opentelemetry/ext/opentracing_shim/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@
7676
While testing this library, the aforementioned imprecisions were observed
7777
to be of *less than a microsecond*.
7878
79+
API
80+
---
7981
.. _Floating Point Arithmetic\\: Issues and Limitations:
8082
https://docs.python.org/3/tutorial/floatingpoint.html
8183
"""

ext/opentelemetry-ext-wsgi/src/opentelemetry/ext/wsgi/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ def hello():
5050
5151
application = get_wsgi_application()
5252
application = OpenTelemetryMiddleware(application)
53+
54+
API
55+
---
5356
"""
5457

5558
import functools

ext/opentelemetry-ext-zipkin/src/opentelemetry/ext/zipkin/__init__.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,6 @@
1515
"""
1616
This library allows to export tracing data to `Zipkin <https://zipkin.io/>`_.
1717
18-
Installation
19-
------------
20-
21-
::
22-
23-
pip install opentelemetry-ext-zipkin
24-
25-
2618
Usage
2719
-----
2820

0 commit comments

Comments
 (0)