Change sphinx default role to "any", update docs (open-telemetry#40)

c24t · web-flow · commit d78ea98f1a07 · 2019-07-08T13:45:55.000-07:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -24,6 +24,9 @@
 
 # -- General configuration ---------------------------------------------------
 
+# Easy automatic cross-references for `code in backticks`
+default_role = 'any'
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
diff --git a/opentelemetry-api/src/opentelemetry/trace/__init__.py b/opentelemetry-api/src/opentelemetry/trace/__init__.py
@@ -75,7 +75,7 @@ def start(self) -> None:
         Each span represents a single operation. The span's start time is the
         wall time at which the operation started.
 
-        Only the first call to ``start`` should modify the span, and
+        Only the first call to `start` should modify the span, and
         implementations are free to ignore or raise on further calls.
         """
 
@@ -84,7 +84,7 @@ def end(self) -> None:
 
         The span's end time is the wall time at which the operation finished.
 
-        Only the first call to ``end`` should modify the span, and
+        Only the first call to `end` should modify the span, and
         implementations are free to ignore or raise on further calls.
         """
 
@@ -153,9 +153,8 @@ def start_span(self,
         this tracer's context.
 
         By default the current span will be used as parent, but an explicit
-        parent can also be specified, either a ``Span`` or a ``SpanContext``.
-        If the specified value is ``None``, the created span will be a root
-        span.
+        parent can also be specified, either a `Span` or a `SpanContext`. If
+        the specified value is `None`, the created span will be a root span.
 
         On exiting the context manager stop the span and set its parent as the
         current span.
