Fix ReadTheDocs headers and sections order for 8 Instrumentors #3719
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tammy-baylis-swi
force-pushed
the
sqlcomment-docs
branch
from
d23a178 to
d980923
Compare
xrmx
approved these changes
Aug 29, 2025
emdneto
approved these changes
Aug 29, 2025
github-project-automation
bot
moved this from Easy to review / merge / close
to Done
in @xrmx's Python PR digest
zhirafovod
pushed a commit
to zhirafovod/opentelemetry-python-contrib
that referenced
this pull request
Sep 15, 2025
…telemetry#3719) * Fix readthedocs headers * Changelog * Add header
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The order of headers and sections for 8 instrumentors' ReadTheDocs content is messed up, so I'm fixing them.
The contents of the sections themselves have not changed (text, code examples); I only moved them around.
Before this change, Django docs:
With this change, 3 sections with subheaders:
Partially fixes #3162
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
tox -e docsdocs/_build/html/instrumentation/*/*.htmlDoes This PR Require a Core Repo Change?
Checklist:
See contributing.md for styleguide, changelog guidelines, and more.