fix docs and add changelog

Signed-off-by: emdneto <[email protected]>
emdneto · Oct 7, 2024 · 87d33b3 · 87d33b3
1 parent dbecc8b
commit 87d33b3
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4094](https://github.com/open-telemetry/opentelemetry-python/pull/4094))
 - Implement events sdk
   ([#4176](https://github.com/open-telemetry/opentelemetry-python/pull/4176))
+- Add support to protobuf5
+  ([#4206](https://github.com/open-telemetry/opentelemetry-python/pull/4206))
 
 ## Version 1.27.0/0.48b0 (2024-08-28)
 

diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -25,7 +25,4 @@ opentracing~=2.2.0
 thrift~=0.10
 wrapt>=1.0.0,<2.0.0
 markupsafe~=2.0
-
-# Jaeger generated protobufs do not currently support protobuf 4.x. This can be removed once
-# they're regenerated.
 protobuf==5.26.1
diff --git a/tox.ini b/tox.ini
@@ -347,6 +347,11 @@ recreate = True
 deps =
   -c {toxinidir}/dev-requirements.txt
   -r {toxinidir}/docs-requirements.txt
+setenv =
+  ; We need this workaround to allow generating docs for exporters that have different protobuf versions as requirement.
+  ; See https://github.com/open-telemetry/opentelemetry-python/pull/4206
+  ; We can remove the workaround when opentelemetry-exporter-zipkin-proto-http support protobuf > 5.26
+  PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python
 changedir = docs
 commands =
   sphinx-build -E -a -W -b html -T . _build/html