question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

DOC,BLD: Switch to `xelatex` engine for latex docs?

See original GitHub issue

When building the latex/pdf version of the documentation, sphinx is currently configured to use pdflatex (the default) to build the pdfs of the user/reference manuals. There are several places in the documentation where the use of unicode characters causes inputenc warnings when building the pdf. In some cases these can be resolved by ensuring that extra latex packages are installed (e.g. texlive-langgreek adds the necessary mappings for some Greek Unicode characters), but in other cases (e.g. U+22EE vertical dots) it is more difficult to find an appropriate package (or the mapping can be done manually via \DeclareUnicodeCharacter).

In addition, there seem to be some URL ref problems that are avoided by xelatex (see sphinx-doc/sphinx#7723).

Please share any thoughts and possible pros/cons of switching to xelatex for the NumPy latex/pdf docs. Note that sphinx provides a latex_engine configuration option that makes this simple to try.

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:3
  • Comments:6 (6 by maintainers)

github_iconTop GitHub Comments

2reactions
melissawmcommented, May 27, 2020

Oh, then if it’s irrelevant I’d say we go for it. xelatex is available in every major LaTeX distribution on whatever OS, and it does make everything easier with respect to unicode and font issues.

0reactions
rossbarcommented, May 27, 2020

I like xelatex personally, but it can be much slower than pdflatex. Could that impact the docs build time significantly or is that irrelevant here?

Great point - I did some quick profiling to get an idea of the build times. The results of time make -C build/latex on my system

with pdflatex:

real    0m43.972s                                                               
user    0m43.154s                                                               
sys     0m0.552s

with xelatex:

real    1m13.522s                                                               
user    1m19.858s                                                               
sys     0m2.205s

So xelatex is definitely slower, but the total build time still isn’t so bad, especially since I don’t think building the latex docs from source is very common for most users. Note that in each case, the latex->pdf step is still shorter than the initial rST->latex step (~2m30s on my system).

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to switch between pdfLaTeX and XeLaTeX with some ...
I have to compile Latin documents in pdfLatex and Persian documents in XeLatex. But I'd rather to change the configuration of LaTeX with...
Read more >
Changing compiler - Overleaf, Online LaTeX Editor
With Overleaf, you can choose between pdfLaTeX, LaTeX, XƎLaTeX, and LuaLaTeX. To change the compiler, simply click into the left hand menu. Lefthandmenu.PNG....
Read more >
Rmarkdown with xelatex - Stack Overflow
I'm trying to use Calibri font, but from what I understand I first need to be able to use the xelatex engine.
Read more >
Ipe Manual -- 7.2 Using Xetex
If you set the LaTeX engine to xetex (you set this in the Document properties dialog, available on the Edit menu), then Ipe...
Read more >
Generating LaTeX — Agda 2.6.1.3 documentation
where latex-compiler could be pdflatex, xelatex or lualatex, ... Note that you might not want to turn off all kinds of ligatures in...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found