| Message ID | 20241106-pdf-xetex-v1-0-044eab7e77d3@bootlin.com |
|---|---|
| Headers | show |
| Series | Add support for PDF/Epub generation | expand |
On Wed, 2024-11-06 at 08:48 +0100, Antonin Godard wrote: > This patch series includes commits that enable PDF and Epub generation > during `make publish` and that includes them in the sidebar as a new > "Documentation Downloads" section. The files can be downloaded directly > from there and are displayed as a list in this page. > > Example outputs: > > - PDF: https://lufi.bootlin.com/r/PBq0qGTwBy#6JIczWeLiAjcwn9udqAeTaoHuZhoXq6sL/vpktteg5w= > - EPub: https://lufi.bootlin.com/r/_wRND0dvKD#88YA3opgX/CJTaGT3m5GxKBMBYeNfcR2VN3x7wnCU/E= > > This patch series also changes the following: > > - Don't use inkscape but rsvg-convert, a lighter tool for SVG conversion > that can be included in a buildtools tarball. > - Build the PDF with xelatex instead of pdflatex, to support foreign > characters (the pdf build is currently failing because of that). > > On the autobuilder, the necessary was made to make texlive/xelatex and > so on available to the docs build (see run-docs-build). > > The series also brings a change to switchers.js.in, to make the file > compatible with newer versions of Sphinx. Note: on the autobuilder, we > aim to build using the newer Sphinx (8.1.3). > > I'm currently working on updating the dependency list in poky.yaml.in > (and where this file is used), but would like to send this series first > to have some feedback. FWIW I'm really happy to see this getting sorted out! The patches seem reasonable to me. Cheers, Richard
This patch series includes commits that enable PDF and Epub generation during `make publish` and that includes them in the sidebar as a new "Documentation Downloads" section. The files can be downloaded directly from there and are displayed as a list in this page. Example outputs: - PDF: https://lufi.bootlin.com/r/PBq0qGTwBy#6JIczWeLiAjcwn9udqAeTaoHuZhoXq6sL/vpktteg5w= - EPub: https://lufi.bootlin.com/r/_wRND0dvKD#88YA3opgX/CJTaGT3m5GxKBMBYeNfcR2VN3x7wnCU/E= This patch series also changes the following: - Don't use inkscape but rsvg-convert, a lighter tool for SVG conversion that can be included in a buildtools tarball. - Build the PDF with xelatex instead of pdflatex, to support foreign characters (the pdf build is currently failing because of that). On the autobuilder, the necessary was made to make texlive/xelatex and so on available to the docs build (see run-docs-build). The series also brings a change to switchers.js.in, to make the file compatible with newer versions of Sphinx. Note: on the autobuilder, we aim to build using the newer Sphinx (8.1.3). I'm currently working on updating the dependency list in poky.yaml.in (and where this file is used), but would like to send this series first to have some feedback. Signed-off-by: Antonin Godard <antonin.godard@bootlin.com> --- Antonin Godard (4): doc: Makefile: remove inkscape, replace by rsvg-convert doc: Makefile: add support for xelatex doc: add a download page for epub and pdf sphinx-static/switchers.js.in: do not refer to URL_ROOT anymore Michael Opdenacker (1): doc: Makefile: publish pdf and epub versions too documentation/Makefile | 17 +++++++++++------ documentation/conf.py | 7 ++++++- documentation/downloads.rst | 11 +++++++++++ documentation/index.rst | 7 +++++++ documentation/sphinx-static/switchers.js.in | 6 ++++++ 5 files changed, 41 insertions(+), 7 deletions(-) --- base-commit: bb472a7000672ce836573c3f2d3baf42cca01546 change-id: 20241010-pdf-xetex-06ac6b0f6b87 Best regards,