From: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Masahiro Yamada <masahiroy@kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
Michal Marek <michal.lkml@markovi.net>,
linux-kbuild@vger.kernel.org, linux-kernel@vger.kernel.org,
linux-media@vger.kernel.org
Subject: Re: [PATCH RFC v2] docs: experimental: build PDF with rst2pdf
Date: Sat, 12 Dec 2020 00:54:35 +0100 [thread overview]
Message-ID: <20201212005435.0e1a0871@coco.lan> (raw)
In-Reply-To: <20201211134859.5ab8e0c2@lwn.net>
Em Fri, 11 Dec 2020 13:48:59 -0700
Jonathan Corbet <corbet@lwn.net> escreveu:
> On Fri, 11 Dec 2020 09:33:32 +0100
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
>
> > Add an experimental PDF builder using rst2pdf
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >
> > Please notice that 18 documents (of a total of 71) won't build with
> > rst2pdf. There's an opened issue about that at:
> >
> > https://github.com/rst2pdf/rst2pdf/issues/958
> >
> > v2: usage of SPHINXDIRS was fixed.
> >
> >
> > Documentation/Makefile | 5 +++++
> > Documentation/conf.py | 21 +++++++++++++++------
> > Documentation/sphinx/load_config.py | 12 ++++++++++++
> > Documentation/userspace-api/media/Makefile | 1 +
> > Makefile | 4 ++--
> > 5 files changed, 35 insertions(+), 8 deletions(-)
>
> So I would dearly love to have rst2pdf working.
>
> I applied this, then tried to see what would happen if I ran a build
> without having rst2pdf installed:
>
> > 1108 meer kernel: make htmldocs
> > SPHINX htmldocs --> file:///stuff/k/git/kernel/Documentation/output
> > make[2]: Nothing to be done for 'html'.
> > WARNING: The kernel documentation build process
> > support for Sphinx v3.0 and above is brand new. Be prepared for
> > possible issues in the generated output.
> > enabling CJK for LaTeX builder
> >
> > Extension error:
> > Could not import extension rst2pdf.pdfbuilder (exception: No module named 'rst2pdf')
> > make[1]: *** [Documentation/Makefile:91: htmldocs] Error 2
> > make: *** [Makefile:1663: htmldocs] Error 2
>
> Methinks it's perhaps not quite ready for linux-next yet :)
Well, I haven't test this.
I'm not an usual python programmer, so, don't know much about its
specifics... Yet, I would be expecting that something like this:
try:
extensions.append("rst2pdf.pdfbuilder")
except:
sys.stderr.write('rst2pdf extension not available.\n')
Would avoid it to crash, if the extension is not available.
Silly me :-)
Still, I suspect that it should not be hard to modify the above to
avoid the crash.
I shouldn't be doing much development those days, as I'm taking
some vacations, after sending media stuff for 5.11.
So, if you have a better idea about how to optionally probe an
extension, feel free to modify my patch.
> With rst2pdf installed I get a bunch of zero-length files, as promised.
> Pretty much none of the larger "books" make it through.
Yeah. I guess one of the issues is with tables that don't fit into
a single page.
Yet, devicetree book is empty. That sounds really weird, as there are
few files on it, and I didn't see anything uncommon on the rst files.
> It's a start,
> though. I'll happily apply this as a step forward once it doesn't break
> the docs build if rst2pdf is missing.
Sounds like a plan.
Thanks,
Mauro
next prev parent reply other threads:[~2020-12-12 0:03 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-10 10:55 [PATCH 00/13] Address issues with PDF output at media uAPI docs Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 01/13] docs: conf.py: fix sphinx version detection for margin set Mauro Carvalho Chehab
2020-12-10 14:48 ` Jonathan Corbet
2020-12-10 16:01 ` [PATCH RFC] docs: experimental: build PDF with rst2pdf Mauro Carvalho Chehab
2020-12-10 16:29 ` Mauro Carvalho Chehab
2020-12-11 8:33 ` [PATCH RFC v2] " Mauro Carvalho Chehab
2020-12-11 20:48 ` Jonathan Corbet
2020-12-11 23:54 ` Mauro Carvalho Chehab [this message]
2020-12-12 0:03 ` Jonathan Corbet
2020-12-10 16:03 ` [PATCH 01/13] docs: conf.py: fix sphinx version detection for margin set Mauro Carvalho Chehab
2020-12-28 17:19 [PATCH RFC v2] docs: experimental: build PDF with rst2pdf Nícolas F. R. A. Prado
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=20201212005435.0e1a0871@coco.lan \
--to=mchehab+huawei@kernel.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kbuild@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=masahiroy@kernel.org \
--cc=mchehab@kernel.org \
--cc=michal.lkml@markovi.net \
/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).