From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>,
Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
"Mauro Carvalho Chehab" <mchehab+huawei@kernel.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH v2 04/14] docs: conf.py: rename some vars at latex_documents logic
Date: Thu, 21 Aug 2025 10:16:40 +0200 [thread overview]
Message-ID: <b030d9bc53550905adbe9367b2a3915d7331b4c5.1755763127.git.mchehab+huawei@kernel.org> (raw)
In-Reply-To: <cover.1755763127.git.mchehab+huawei@kernel.org>
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>
---
Documentation/conf.py | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/Documentation/conf.py b/Documentation/conf.py
index c8401ed75402..6e12c7d8e07e 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -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"))
--
2.50.1
next prev parent reply other threads:[~2025-08-21 8:17 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-08-21 8:16 [PATCH v2 00/14] Fix PDF doc builds on major distros Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 01/14] docs: Makefile: Fix LaTeX paper size settings Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 02/14] docs: conf.py: better handle latex documents Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 03/14] docs: conf.py: fix doc name with SPHINXDIRS Mauro Carvalho Chehab
2025-08-21 8:16 ` Mauro Carvalho Chehab [this message]
2025-08-21 8:16 ` [PATCH v2 05/14] docs: conf.py: use dedent and r-strings for LaTeX macros Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 06/14] docs: conf.py: fix some troubles for LaTeX output Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 07/14] docs: conf.py: extra cleanups and fixes Mauro Carvalho Chehab
2025-08-22 12:01 ` Akira Yokosawa
2025-08-22 13:27 ` Mauro Carvalho Chehab
2025-08-22 22:34 ` Jonathan Corbet
2025-08-25 12:07 ` Mauro Carvalho Chehab
2025-08-25 12:15 ` Jonathan Corbet
2025-08-25 17:11 ` Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 08/14] scripts: sphinx-pre-install: fix PDF build issues on Ubuntu Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 09/14] scripts: sphinx-pre-install: add missing gentoo pdf dependencies Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 10/14] scripts: sphinx-pre-install: fix PDF dependencies for openSuse Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 11/14] scripts: sphinx-pre-install: fix dependencies for OpenMandriva Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 12/14] scripts: sphinx-pre-install: fix pdf dependencies for Mageia 9 Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 13/14] scripts: sphinx-pre-install: fix PDF dependencies for gentoo Mauro Carvalho Chehab
2025-08-21 8:16 ` [PATCH v2 14/14] scripts/sphinx-pre-install: fix Archlinux PDF dependencies Mauro Carvalho Chehab
2025-08-21 19:22 ` [PATCH v2 00/14] Fix PDF doc builds on major distros Jonathan Corbet
2025-08-21 19:43 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b030d9bc53550905adbe9367b2a3915d7331b4c5.1755763127.git.mchehab+huawei@kernel.org \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®