Skip to content

Prepare Sphinx to build media PDF books

Mauro Carvalho Chehab linux-media 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest9 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/9docs-rst: fix a breakage when building PDF documentsDocumentation/Makefile.sphinx+1 -10 replies
2/9docs-rst: remove a rst2pdf left over codeDocumentation/conf.py+0 -70 replies
3/9docs-rst: allow generating some LaTeX pages in landscapeDocumentation/conf.py+8 -50 replies
4/9docs-rst: improve output for .. notes:: on LaTeXDocumentation/conf.py+23 -00 replies
5/9docs-rst: Don't mangle with UTF-8 chars on LaTeX/PDF outputDocumentation/Makefile.sphinx Documentation/conf.py+14 -30 replies
6/9docs-rst: better adjust margins and font sizeDocumentation/conf.py+4 -10 replies
7/9docs-rst: parse-heraders.pl: escape LaTeX charactersDocumentation/sphinx/parse-headers.pl+1 -10 replies
8/9docs-rst: Don't go to interactive mode on errorsDocumentation/Makefile.sphinx+1 -10 replies
9/9docs-rst: enable the Sphinx math extensionDocumentation/conf.py+11 -00 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/9] Prepare Sphinx to build media PDF books

This patch series fix Sphinx to allow it to build the media documentation as a PDF file.

The first patch is actually a bug fix: one of the previous patch broke compilation for PDF as a hole, as it added an extra parenthesis to a function call.

The second patch just removes a left over code for rst2pdf.

The other patches change from "pdflatex" to "xelatex" and address several issues that prevent building the media books.

Jon,

I think this patch series belong to docs-next. Feel free to merge them there, if you agree. There's one extra patch that touches Documentation/conf.py, re-adding the media book to the PDF build, but IMHO this one would be better to be merged via the media tree, after the fixes inside the media documentation to fix the build.

I'm sending the media-specific patches on a separate patch series, meant to be merged via the media tree.

As on the previous experimental patch series, I'm pushing the entire stuff on my development tree, at:
https://git.linuxtv.org//mchehab/experimental.git/log/?h=docs-next

The generated PDF file is at:
https://mchehab.fedorapeople.org/media.pdf

Please notice that lots of tables are broken. Fixing them would require manual work, as we'll need to add tags to specify the column size via tabularcolumns, long tables should use the cssclass:: longtable, and very wide tables will need to be rotated and size-adjusted.

Anyway, at least *some* PDF support for media books are now possible.

Mauro Carvalho Chehab (9):
docs-rst: fix a breakage when building PDF documents
docs-rst: remove a rst2pdf left over code
docs-rst: allow generating some LaTeX pages in landscape
docs-rst: improve output for .. notes:: on LaTeX
docs-rst: Don't mangle with UTF-8 chars on LaTeX/PDF output
docs-rst: better adjust margins and font size
docs-rst: parse-heraders.pl: escape LaTeX characters
docs-rst: Don't go to interactive mode on errors
docs-rst: enable the Sphinx math extension

 Documentation/Makefile.sphinx         |  8 ++---
 Documentation/conf.py                 | 66 +++++++++++++++++++++++++++++------
 Documentation/sphinx/parse-headers.pl |  2 +-
 3 files changed, 60 insertions(+), 16 deletions(-)
Signature · 1 line
2.7.4