git/linux-net
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/netdev/net.git/ synced 2026-04-05 00:07:48 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: conf.py: rename some vars at latex_documents logic

Browse Source 
Currently, the logic uses fn and doc vars, but they don't
properly describe what such vars do.

Make them clearer:
	- fname: points to the file name to search (index.rst);
	- doc: contains the name of the LaTeX or PDF doc to
	  be produced.

With that, the checks for SPHINXDIRS and for subdirs will
be more coherent.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/b030d9bc53550905adbe9367b2a3915d7331b4c5.1755763127.git.mchehab+huawei@kernel.org
This commit is contained in:
Mauro Carvalho Chehab
2025-08-21 10:16:40 +02:00
committed by Jonathan Corbet
parent 280fa75c2c
commit 9fd4e4ce7e
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
Documentation/conf.py
View File

@@ -93,31 +93,31 @@ def config_init(app, config):
# When SPHINXDIRS is used, we just need to get index.rst, if it exists
if not os.path.samefile(doctree, app.srcdir):
doc = "index"
doc_name = os.path.basename(app.srcdir)
if os.path.exists(os.path.join(app.srcdir, doc + ".rst")):
latex_documents.append((doc, doc_name + ".tex",
"Linux %s Documentation" % doc_name.capitalize(),
doc = os.path.basename(app.srcdir)
fname = "index"
if os.path.exists(os.path.join(app.srcdir, fname + ".rst")):
latex_documents.append((fname, doc + ".tex",
"Linux %s Documentation" % doc.capitalize(),
"The kernel development community",
"manual"))
return
# When building all docs, or when a main index.rst doesn't exist, seek
# for it on subdirectories
for fn in os.listdir(app.srcdir):
doc = os.path.join(fn, "index")
if not os.path.exists(os.path.join(app.srcdir, doc + ".rst")):
for doc in os.listdir(app.srcdir):
fname = os.path.join(doc, "index")
if not os.path.exists(os.path.join(app.srcdir, fname + ".rst")):
continue
has = False
for l in latex_documents:
if l[0] == doc:
if l[0] == fname:
has = True
break
if not has:
latex_documents.append((doc, fn + ".tex",
"Linux %s Documentation" % fn.capitalize(),
latex_documents.append((fname, doc + ".tex",
"Linux %s Documentation" % doc.capitalize(),
"The kernel development community",
"manual"))