raspi/linux
1
0
Fork 1
mirror of https://github.com/raspberrypi/linux.git synced 2025-12-15 22:41:38 +00:00
Code Issues Projects Releases Wiki Activity

docs: kernel_include.py: remove line numbers from parsed-literal

Browse Source 
When parsed-literal directive is added to rawtext, while cross
references will be properly displayed, Sphinx will ignore
line numbers. So, it is not worth adding them.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/b484fe5fcbf6e5217f112f205fbf54f0bbc3dcca.1755872208.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab
2025-08-22 16:19:32 +02:00
committed by Jonathan Corbet
parent 01dba1680c
commit 4aa578f9c0
1 changed files with 15 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/sphinx/kernel_include.py
View File

@@ -171,13 +171,24 @@ class KernelInclude(Include):
if 'warn-broken' in self.options:
env._xref_files.add(path)
if "toc" in self.options:
rawtext = parser.gen_toc()
else:
if "toc" not in self.options:
rawtext = ".. parsed-literal::\n\n" + parser.gen_output()
self.apply_range(rawtext)
title = os.path.basename(path)
include_lines = statemachine.string2lines(rawtext, tab_width,
convert_whitespace=True)
# Sphinx always blame the ".. <directive>", so placing
# line numbers here won't make any difference
self.state_machine.insert_input(include_lines, path)
return []
# TOC output is a ReST file, not a literal. So, we can add line
# numbers
rawtext = parser.gen_toc()
include_lines = statemachine.string2lines(rawtext, tab_width,
convert_whitespace=True)