Docs: highlight key optimization code lines with :emphasize-lines:#21568

Open

tsubasakong wants to merge 2 commits intoLightning-AI:masterfrom

tsubasakong:docs/12119_emphasize-lines

tsubasakong commented Mar 6, 2026 •

edited by github-actions bot

Loading

What does this PR do?

Fixes #12119.

This PR adds Sphinx :emphasize-lines: directives to key Python examples in the optimization docs so readers can quickly spot the important lines:

Automatic optimization loop internals (closure / step points)
Accessing the wrapped optimizer vs. raw optimizer
Custom LR scheduler integration
Gradient clipping customization
estimated_stepping_batches usage with OneCycleLR

These are docs-only changes (no behavior changes).

Before submitting

Did you read the contributor guideline, Pull Request section?
Did you make sure your PR does only one thing?
Did you verify relevant checks locally for this docs-only change?

📚 Documentation preview 📚: https://pytorch-lightning--21568.org.readthedocs.build/en/21568/


          Docs: add emphasize-lines highlights in optimization examples

05a6ef7

tsubasakong requested review from ethanwharris, justusschock, lantiga and tchaton as code owners

March 6, 2026 08:57

github-actions bot added docs pl labels


          Merge remote-tracking branch 'upstream/master' into docs/12119_emphas…

70dd22b

…ize-lines

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lantiga Awaiting requested review from lantiga lantiga is a code owner

tchaton Awaiting requested review from tchaton tchaton is a code owner

justusschock Awaiting requested review from justusschock justusschock is a code owner

ethanwharris Awaiting requested review from ethanwharris ethanwharris is a code owner

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

Labels

docs pl