Skip to content

fix(confluent-kafka): fix malformed RST in instrumentation docs#4362

Open
mvanhorn wants to merge 2 commits intoopen-telemetry:mainfrom
mvanhorn:osc/3061-fix-kafka-docs-rst
Open

fix(confluent-kafka): fix malformed RST in instrumentation docs#4362
mvanhorn wants to merge 2 commits intoopen-telemetry:mainfrom
mvanhorn:osc/3061-fix-kafka-docs-rst

Conversation

@mvanhorn
Copy link
Copy Markdown

@mvanhorn mvanhorn commented Mar 26, 2026

Summary

Fixes the confluent_kafka instrumentation docs RST to match the pattern used by aiokafka and kafka_python.

Changes

docs/instrumentation/confluent_kafka/confluent_kafka.rst:

  • Added :end-before: References to the include directive (prevents raw URLs from rendering inline)
  • Added API section header before the automodule directive
  • Removed :noindex: to match the other kafka docs

The file now matches the structure of aiokafka.rst and kafka_python.rst exactly.

Testing

Verified the RST structure matches docs/instrumentation/aiokafka/aiokafka.rst via diff.

Fixes #3061

This contribution was developed with AI assistance (Claude Code).

@mvanhorn mvanhorn requested a review from a team as a code owner March 26, 2026 07:00
@linux-foundation-easycla
Copy link
Copy Markdown

linux-foundation-easycla bot commented Mar 26, 2026 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: emdneto / name: Emídio Neto (1071f99)
  • ✅ login: mvanhorn / name: Matt Van Horn (47014f0)

@tammy-baylis-swi
Copy link
Copy Markdown
Contributor

tammy-baylis-swi commented Mar 26, 2026

Thanks @mvanhorn ! Please could you also sign the CLA

@tammy-baylis-swi tammy-baylis-swi moved this to Reviewed PRs that need fixes in Python PR digest Mar 26, 2026
@mvanhorn
Copy link
Copy Markdown
Author

mvanhorn commented Mar 27, 2026

On it - signing the CLA now.

@tammy-baylis-swi
Copy link
Copy Markdown
Contributor

tammy-baylis-swi commented Mar 27, 2026

Please also check the exact syntax with tox -e docs (some info in Contributing)

@mvanhorn
Copy link
Copy Markdown
Author

mvanhorn commented Mar 27, 2026

Ran tox -e docs locally - it fails during dependency installation (mysqlclient build requires pkg-config, and fastapi/starlette version conflict on Python 3.9). These are pre-existing environment issues unrelated to the RST change.

The change itself is a simple RST fix: adding :end-before: References to the include directive and an API section header. Verified the syntax parses correctly. Happy to adjust anything if the CI docs build flags a specific issue.

emdneto
emdneto reviewed Mar 27, 2026
View reviewed changes
docs/instrumentation/confluent_kafka/confluent_kafka.rst
:members:
:undoc-members:
:show-inheritance:
:noindex:
Copy link
Copy Markdown
Member

@emdneto emdneto Mar 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

It seems we need to keep that.

emdneto
emdneto reviewed Mar 27, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@emdneto emdneto left a comment

Choose a reason for hiding this comment

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

Pls sign CLA

@mvanhorn
fix(confluent-kafka): fix malformed RST in instrumentation docs
47014f0 
Add missing :end-before: References directive and API section
header to confluent_kafka docs, matching the pattern used by
aiokafka and kafka_python instrumentation docs.

Without :end-before:, the raw References URLs were rendered
inline in the docs page. The missing API header left the
automodule section unlabeled.

Fixes open-telemetry#3061
@mvanhorn mvanhorn force-pushed the osc/3061-fix-kafka-docs-rst branch from 82e2050 to 47014f0 Compare March 28, 2026 00:12
@mvanhorn
Copy link
Copy Markdown
Author

mvanhorn commented Mar 28, 2026

Pls sign CLA

working now! had signed but had messed something up

@tammy-baylis-swi tammy-baylis-swi added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Mar 30, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@emdneto emdneto emdneto left review comments

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

Python PR digest
Status: Reviewed PRs that need fixes

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Instrumentation kafka docs malformed with wrong rst blocks

3 participants

@mvanhorn @tammy-baylis-swi @emdneto