From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
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: Fri, 11 Dec 2020 13:48:59 -0700 [thread overview]
Message-ID: <20201211134859.5ab8e0c2@lwn.net> (raw)
In-Reply-To: <b73c93c6946ab324443608fac62333b7e327a7e4.1607675494.git.mchehab+huawei@kernel.org>
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 :)
With rst2pdf installed I get a bunch of zero-length files, as promised.
Pretty much none of the larger "books" make it through. 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.
Thanks,
jon
next prev parent reply other threads:[~2020-12-11 21:42 UTC|newest]
Thread overview: 23+ 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 [this message]
2020-12-11 23:54 ` Mauro Carvalho Chehab
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-10 10:55 ` [PATCH 02/13] media: colorspaces-details.rst: drop tabularcolumns Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 03/13] media: control.rst: use a table for V4L2_CID_POWER_LINE Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 04/13] media: docs: sliced-vbi: fix V4L2_SLICED_WSS_625 docs Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 05/13] media: ext-ctrls-codec-stateless.rst: change a FWHT flag description Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 06/13] media: ext-ctrls-codec.rst: add a missing profile description Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 07/13] media: ext-ctrls-codec.rst: simplify a few tables Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 08/13] media: ext-ctrls-jpeg.rst: cleanup V4L2_CID_JPEG_COMPRESSION_QUALITY text Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 09/13] media: docs: pixfmt: use section titles for bayer formats Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 10/13] media: buffer.rst: fix a PDF output issue Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 11/13] media: ext-ctrls-codec-stateless.rst: fix an H-264 table format Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 12/13] media: pixfmt-yuv-planar.rst: fix PDF OUTPUT Mauro Carvalho Chehab
2020-12-10 10:55 ` [PATCH 13/13] media: docs: uAPI: fix table output in LaTeX/PDF format Mauro Carvalho Chehab
-- strict thread matches above, loose matches on Subject: below --
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=20201211134859.5ab8e0c2@lwn.net \
--to=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+huawei@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).