linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 2/2] docs: conf.py: get rid of load_config.py
Date: Sat, 20 Sep 2025 11:36:44 +0200	[thread overview]
Message-ID: <20250920113644.67194409@foz.lan> (raw)
In-Reply-To: <87plbmqg0f.fsf@trenco.lwn.net>

Em Fri, 19 Sep 2025 15:38:56 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > The code here was meant to handle 3 functions:
> > 1. allow having a separate conf.py file, per subdir;
> > 2. generate a list of latex documents.
> > 3. set "subproject" tag if SPHINXDIRS points to a subdir.
> >
> > We don't have (1) anymore, and (3) is now properly handled
> > entirely inside conf.py.
> >
> > So, only (3) is still needed, and this is a single-line change
> > at conf.py.
> >
> > So, drop it, moving the remaining code to conf.py.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/Makefile              |  4 --
> >  Documentation/conf.py               | 15 +++-----
> >  Documentation/sphinx/load_config.py | 60 -----------------------------
> >  3 files changed, 5 insertions(+), 74 deletions(-)
> >  delete mode 100644 Documentation/sphinx/load_config.py
> >
> > diff --git a/Documentation/Makefile b/Documentation/Makefile
> > index 6ccd5db1dcbd..9663e7a31feb 100644
> > --- a/Documentation/Makefile
> > +++ b/Documentation/Makefile
> > @@ -24,7 +24,6 @@ SPHINXDIRS    = .
> >  DOCS_THEME    =
> >  DOCS_CSS      =
> >  RUSTDOC       =
> > -SPHINX_CONF   = conf.py
> >  PAPER         =
> >  BUILDDIR      = $(obj)/output
> >  PDFLATEX      = xelatex
> > @@ -108,9 +107,6 @@ dochelp:
> >  	@echo  '  make SPHINXDIRS="s1 s2" [target] Generate only docs of folder s1, s2'
> >  	@echo  '  valid values for SPHINXDIRS are: $(_SPHINXDIRS)'
> >  	@echo
> > -	@echo  '  make SPHINX_CONF={conf-file} [target] use *additional* sphinx-build'
> > -	@echo  '  configuration. This is e.g. useful to build with nit-picking config.'
> > -	@echo
> >  	@echo  '  make DOCS_THEME={sphinx-theme} selects a different Sphinx theme.'  
> 
> So probably I'm a little slow today, but this confuses me.  Even after
> this change, the makefile still uses SPHINX_CONF, so I'm not sure how it
> is supposed to be set?

Heh, incomplete patch, sorry for that. I'll send a v2 of this series.


Thanks,
Mauro

      reply	other threads:[~2025-09-20  9:36 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-09-19 15:09 [PATCH 0/2] A couple patches for sphinx-build-wrapper Mauro Carvalho Chehab
2025-09-19 15:09 ` [PATCH 1/2] tools/docs: sphinx-build-wrapper: handle sphinx-build errors Mauro Carvalho Chehab
2025-09-19 15:10 ` [PATCH 2/2] docs: conf.py: get rid of load_config.py Mauro Carvalho Chehab
2025-09-19 21:38   ` Jonathan Corbet
2025-09-20  9:36     ` Mauro Carvalho Chehab [this message]

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=20250920113644.67194409@foz.lan \
    --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;
as well as URLs for NNTP newsgroup(s).