Use :emphasize-lines: in sphinx docs to highlight code. · Lightning-AI/pytorch-lightning#12119

(10 comments) (2 reactions) (0 assignees)Python (26,687 stars) (3,233 forks)batch import

docsgood first issuepriority: 1

Description

📚 Documentation

For typos and doc fixes, please go ahead and:

.. code-block:: python
   :emphasize-lines: 3,5

   def some_function():
       interesting = False
       print 'This line is highlighted.'
       print 'This one is not...'
       print '...but this one is.'

If you enjoy Lightning, check out our other projects! ⚡

Metrics: Machine learning metrics for distributed, scalable PyTorch applications.
Lite: enables pure PyTorch users to scale their existing code on any kind of device while retaining full control over their own loops and optimization logic.
Flash: The fastest way to get a Lightning baseline! A collection of tasks for fast prototyping, baselining, fine-tuning, and solving problems with deep learning.
Bolts: Pretrained SOTA Deep Learning models, callbacks, and more for research and production with PyTorch Lightning and PyTorch.
Lightning Transformers: Flexible interface for high-performance research using SOTA Transformers leveraging Pytorch Lightning, Transformers, and Hydra.

cc @borda @rohitgr7 @tchaton @akihironitta

Contributor guide

Tech stack: python
Domain: documentation
Issue type: documentation
Difficulty: 2
Estimated time: under 1 hour
Activity status: fresh
Clarity: clear
Prerequisites: basic PythonSphinx documentation experience
Newbie friendliness: 90
Research direction: Look for Python code blocks in the Sphinx documentation files (e.g., .rst files) that would benefit from highlighting specific lines. Add the `:emphasize lines:` directive as shown in the issue example. Ensure the highlighting correctly marks the intended lines.