Skip to content
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

Propagate API module & propagators package missing from API docs #2785

Merged
merged 5 commits into from
Jun 29, 2022
Merged

Propagate API module & propagators package missing from API docs #2785

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2257e93
Propagate API module missing from docs.
Oberon00 Jun 28, 2022
74152e6
Add CHANGELOG.
Oberon00 Jun 28, 2022
9fc68f2
Sphinx complains about more missing classes.
Oberon00 Jun 28, 2022
0370156
More fixes, understood why Sphinx didn't find some link targets.
Oberon00 Jun 28, 2022
8afed9c
Update CHANGELOG.
Oberon00 Jun 28, 2022
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
([#2748](https://github.com/open-telemetry/opentelemetry-python/pull/2748))
- Fix Jaeger propagator usage with NonRecordingSpan
([#2762](https://github.com/open-telemetry/opentelemetry-python/pull/2762))
- Add `opentelemetry.propagate` module and `opentelemetry.propagators` package
to the API reference documentation
([#2785](https://github.com/open-telemetry/opentelemetry-python/pull/2785))


## [1.12.0rc1-0.31b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.12.0rc1-0.31b0) - 2022-05-17
Expand Down
2 changes: 2 additions & 0 deletions docs/api/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ OpenTelemetry Python API

baggage
context
propagate
propagators
trace
metrics
environment_variables
7 changes: 7 additions & 0 deletions docs/api/propagate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry.propagate package
========================================

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

.. automodule:: opentelemetry.propagate
7 changes: 7 additions & 0 deletions docs/api/propagators.composite.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry.propagators.composite
====================================================

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

.. automodule:: opentelemetry.propagators.composite
10 changes: 10 additions & 0 deletions docs/api/propagators.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
opentelemetry.propagators package
========================================

Subpackages
-----------

.. toctree::

propagators.textmap
propagators.composite
7 changes: 7 additions & 0 deletions docs/api/propagators.textmap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
opentelemetry.propagators.textmap
====================================================

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

.. automodule:: opentelemetry.propagators.textmap
20 changes: 3 additions & 17 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,9 @@
# https://github.com/sphinx-doc/sphinx/pull/3744
nitpick_ignore = [
("py:class", "ValueT"),
("py:class", "CarrierT"),
("py:obj", "opentelemetry.propagators.textmap.CarrierT"),
("py:obj", "Union"),
(
"py:class",
"opentelemetry.sdk.metrics._internal.instrument._Synchronous",
Expand All @@ -112,23 +115,6 @@
"py:class",
"opentelemetry.trace._LinkBase",
),
# TODO: Understand why sphinx is not able to find this local class
(
"py:class",
"opentelemetry.propagators.textmap.TextMapPropagator",
),
(
"py:class",
"opentelemetry.propagators.textmap.DefaultGetter",
),
(
"any",
"opentelemetry.propagators.textmap.TextMapPropagator.extract",
),
(
"any",
"opentelemetry.propagators.textmap.TextMapPropagator.inject",
),
]

# Add any paths that contain templates here, relative to this directory.
Expand Down