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

[mvanhorn]

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).

[linux-foundation-easycla]

• ✅ login: emdneto / name: Emídio Neto (1071f99)
• ✅ login: mvanhorn / name: Matt Van Horn (00532bf, 47014f0)
• ❌ The email address for the commit (00532bf) is not linked to the GitHub account, preventing the EasyCLA check. Consult this Help Article and GitHub Help to resolve. (To view the commit's email address, add .patch at the end of this PR page's URL.) For further assistance with EasyCLA, please submit a support request ticket.

One or more co-authors of this pull request were not found. You must specify co-authors in commit message trailer via:

Co-authored-by: name <email>

Supported Co-authored-by: formats include:

1. Anything <id+login@users.noreply.github.com> - it will locate your GitHub user by id part.
2. Anything <login@users.noreply.github.com> - it will locate your GitHub user by login part.
3. Anything <public-email> - it will locate your GitHub user by public-email part. Note that this email must be made public on Github.
4. Anything <other-email> - it will locate your GitHub user by other-email part but only if that email was used before for any other CLA as a main commit author.
5. login <any-valid-email> - it will locate your GitHub user by login part, note that login part must be at least 3 characters long.

Alternatively, if the co-author should not be included, remove the Co-authored-by: line from the commit message.

Please update your commit message(s) by doing git commit --amend and then git push [--force] and then request re-running CLA check via commenting on this pull request:

/easycla

[tammy-baylis-swi]

Thanks @mvanhorn ! Please could you also sign the CLA

[mvanhorn]

On it - signing the CLA now.

[tammy-baylis-swi]

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

[mvanhorn]

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]

It seems we need to keep that.

[emdneto]

Pls sign CLA

[mvanhorn]

Pls sign CLA

working now! had signed but had messed something up

[mvanhorn]

Good catch @emdneto - restored :noindex: in 00532bf. The automodule without it causes a Sphinx duplicate object error since AutoInstrumentedProducer.produce is documented in both the README include and the automodule directive.

[github-actions]

This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment.
If you're still working on this, please add a comment or push new commits.