Skip to content

Commit eee7d84

Browse files
johananlc24t
authored andcommitted
Add documentation for the OpenTracing shim (open-telemetry#244)
1 parent 033bcdc commit eee7d84

File tree

5 files changed

+437
-16
lines changed

5 files changed

+437
-16
lines changed

docs/conf.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,10 @@
1313
import os
1414
import sys
1515

16-
sys.path.insert(0, os.path.abspath("../opentelemetry-api/src/"))
16+
sys.path[:0] = [
17+
os.path.abspath("../opentelemetry-api/src/"),
18+
os.path.abspath("../ext/opentelemetry-ext-opentracing-shim/src/"),
19+
]
1720

1821

1922
# -- Project information -----------------------------------------------------
@@ -47,7 +50,13 @@
4750
"sphinx.ext.githubpages",
4851
]
4952

50-
intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
53+
intersphinx_mapping = {
54+
"python": ("https://docs.python.org/3/", None),
55+
"opentracing": (
56+
"https://opentracing-python.readthedocs.io/en/latest/",
57+
None,
58+
),
59+
}
5160

5261
# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
5362
# Sphinx will warn about all references where the target cannot be found.

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ abstract types for OpenTelemetry implementations.
1919
opentelemetry.metrics
2020
opentelemetry.trace
2121
opentelemetry.util.loader
22+
opentelemetry.ext.opentracing_shim
2223

2324

2425
Indices and tables
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
opentelemetry.ext.opentracing_shim package
2+
==========================================
3+
4+
Module contents
5+
---------------
6+
7+
.. automodule:: opentelemetry.ext.opentracing_shim
8+
:no-show-inheritance:

0 commit comments

Comments
 (0)