Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
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
2 changes: 2 additions & 0 deletions .changelog/5017.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Add missing `.rst` files to Sphinx documentation build for SDK logs,
propagators, and exporter submodules.
7 changes: 7 additions & 0 deletions docs/api/attributes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry.attributes
========================

.. automodule:: opentelemetry.attributes
:members:
:undoc-members:
:show-inheritance:
1 change: 1 addition & 0 deletions docs/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ For the concrete implementation of these interfaces, see the
:maxdepth: 1

_logs
attributes
baggage
context
propagate
Expand Down
10 changes: 10 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@

settings.configure()

# Provide AnyValue in opentelemetry.attributes module's namespace so the
# "AnyValue" forward reference in opentelemetry.util.types._ExtendedAttributes
# resolves when sphinx_autodoc_typehints calls typing.get_type_hints() on
# BoundedAttributes (whose __globals__ is the attributes module). Docs-only.
import opentelemetry.attributes # noqa: E402
from opentelemetry.util.types import AnyValue as _AnyValue # noqa: E402

opentelemetry.attributes.AnyValue = _AnyValue


source_dirs = [
os.path.abspath("../opentelemetry-instrumentation/src/"),
Expand Down Expand Up @@ -181,6 +190,7 @@
"py:class",
"_ExtendedAttributes",
),
("py:class", "Token"),
]

# Add any paths that contain templates here, relative to this directory.
Expand Down
7 changes: 7 additions & 0 deletions docs/sdk/_logs.export.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry.sdk._logs.export
==============================

.. automodule:: opentelemetry.sdk._logs.export
:members:
:undoc-members:
:show-inheritance:
10 changes: 10 additions & 0 deletions docs/sdk/_logs.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
opentelemetry.sdk._logs package
===============================

Submodules
----------

.. toctree::

_logs.export

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

.. automodule:: opentelemetry.sdk._logs
:members:
:undoc-members:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ class InMemoryLogRecordExporter(LogRecordExporter):

This class can be used for testing purposes. It stores the exported logs
in a list in memory that can be retrieved using the
:func:`.get_finished_logs` method.
:meth:`.get_finished_logs` method.
"""

def __init__(self):
Expand Down
Loading