All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 0/2] Two cleanups for Sphinx conf.py
Date: Fri, 8 Sep 2017 16:02:55 -0300	[thread overview]
Message-ID: <20170908160255.217d0e14@vento.lan> (raw)
In-Reply-To: <20170908101026.32969fee@lwn.net>

Em Fri, 8 Sep 2017 10:10:26 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Sun,  3 Sep 2017 16:12:44 -0300
> Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:
> 
> > Those patches are just cleanups for Documentation/conf.py. 
> > 
> > The first one removes a package usage directive for a LateX package
> > that it is not used. 
> > 
> > The second one moves some LaTeX preamble code that it is used only
> > on Sphinx 1.4 and 1.5 to a separate if. On Sphinx 1.6, the macros there
> > are silently ignored. While the conf.py becomes a little bit more complex,
> > it clearly marks the backward-compatible code, with IMHO, it is a
> > good idea, specially as some day, we may drop support for older Sphinx
> > versions.
> > 
> > None of those patches are mandatory. Feel free to apply any time you
> > want (or discard them, if you don't thing it is worth).  
> 
> OK, these are applied (and the adjustbox one too).

Thanks!
> 
> PDF generation seems to work pretty well at the moment, with one
> exception: I don't get a table of contents in any of the files (just a
> blank page saying "Contents").  Are you seeing something different?

That depends on the version. With Sphinx 1.4, the CONTENTS page is
filled with a LaTeX 1-depth ToC (e. g. 2 levels).

With Sphinx 1.6, the first time make pdfdocs is called, it doesn't
produce a CONTENTS page. It does if it is called twice.

I suspect that the difference here is that, with Sphinx up to
version 1.5, the Makefile created under Documentation/output/latex
calls xelatex several times:

%.pdf: %.tex
	$(PDFLATEX) $(LATEXOPTS) '$<'
	$(PDFLATEX) $(LATEXOPTS) '$<'
	$(PDFLATEX) $(LATEXOPTS) '$<'
	-$(MAKEINDEX) -s python.ist '$(basename $<).idx'
	$(PDFLATEX) $(LATEXOPTS) '$<'
	$(PDFLATEX) $(LATEXOPTS) '$<'



With Sphinx 1.6, it calls it only once:

%.pdf: %.tex FORCE_MAKE
	$(PDFLATEX) $(LATEXMKOPTS) '$<'

That seems another regression on Sphinx 1.6.

Regards,
Mauro

      reply	other threads:[~2017-09-08 19:03 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-09-03 19:12 [PATCH 0/2] Two cleanups for Sphinx conf.py Mauro Carvalho Chehab
2017-09-03 19:12 ` [PATCH 1/2] docs-rst: conf.py: remove lscape from LaTeX preamble Mauro Carvalho Chehab
2017-09-03 19:12 ` [PATCH 2/2] docs-rst: conf.py: only setup notice box colors if Sphinx < 1.6 Mauro Carvalho Chehab
2017-09-08 16:10 ` [PATCH 0/2] Two cleanups for Sphinx conf.py Jonathan Corbet
2017-09-08 19:02   ` 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=20170908160255.217d0e14@vento.lan \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@infradead.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.