Skip to content

Add documentation for the OpenTracing shim #244

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
c24t merged 11 commits into from
Nov 25, 2019
Merged

Add documentation for the OpenTracing shim #244

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4a2c643
Add documentation for OpenTracing shim
johananl Oct 23, 2019
9c8845e
Fix types and references in start_span()
johananl Oct 24, 2019
807b3f9
Add intersphinx config for resolving opentracing
johananl Oct 25, 2019
4df5237
Fix types and references in start_active_span()
johananl Oct 25, 2019
cb03ff2
Don't show inheritance in docs
johananl Oct 25, 2019
6e9bf62
Fix types and references
johananl Oct 25, 2019
1286698
Run Black on conf.py
johananl Oct 25, 2019
2f1b72d
Add TODO
johananl Oct 25, 2019
f97fd3b
Add Deprecated to docs dependencies
johananl Nov 18, 2019
f85b2f4
Properly escape backticks to avoid wrong linking
johananl Nov 18, 2019
347cbdf
Make Sphinx path configuration compact
johananl Nov 18, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@
import os
import sys

sys.path.insert(0, os.path.abspath("../opentelemetry-api/src/"))
sys.path[:0] = [
os.path.abspath("../opentelemetry-api/src/"),
os.path.abspath("../ext/opentelemetry-ext-opentracing-shim/src/"),
]


# -- Project information -----------------------------------------------------
Expand Down Expand Up @@ -47,7 +50,13 @@
"sphinx.ext.githubpages",
]

intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)}
intersphinx_mapping = {
"python": ("https://docs.python.org/3/", None),
"opentracing": (
"https://opentracing-python.readthedocs.io/en/latest/",
None,
),
}

# http://www.sphinx-doc.org/en/master/config.html#confval-nitpicky
# Sphinx will warn about all references where the target cannot be found.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ abstract types for OpenTelemetry implementations.
opentelemetry.metrics
opentelemetry.trace
opentelemetry.util.loader
opentelemetry.ext.opentracing_shim


Indices and tables
Expand Down
8 changes: 8 additions & 0 deletions docs/opentelemetry.ext.opentracing_shim.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
opentelemetry.ext.opentracing_shim package
==========================================

Module contents
---------------

.. automodule:: opentelemetry.ext.opentracing_shim
:no-show-inheritance:
Copy link
Copy Markdown
Member

@Oberon00 Oberon00 Oct 28, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why that option?

Copy link
Copy Markdown
Contributor Author

@johananl johananl Nov 18, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See rationale in the commit message of d937117. TL;DR: without this option the links to OpenTracing break because of the current structure of the opentracing package.

If you have an idea how to address this properly, I'd love to hear :-)

Loading