Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use tectonic to build the pdf version of the manual #45027

Open
ViralBShah opened this issue Apr 19, 2022 · 4 comments
Open

Use tectonic to build the pdf version of the manual #45027

ViralBShah opened this issue Apr 19, 2022 · 4 comments
Labels
docsystem The documentation building system upstream The issue is with an upstream dependency, e.g. LLVM

Comments

@ViralBShah
Copy link
Member

Given that tectonic is now in Yggdrasil, it might be nice to move towards using it for building the pdf version of the manual.

Some discussion on how to do that is in JuliaDocs/Documenter.jl#1785 (comment)

@ViralBShah ViralBShah added the docsystem The documentation building system label Apr 19, 2022
@fredrikekre
Copy link
Member

Probably requires changes in Documenter? Perhaps move there or at least have an issue there too.

@inkydragon
Copy link
Member

xref: Migrate the PDF docs build to Buildkite JuliaCI/julia-buildkite#198

@nsajko
Copy link
Contributor

nsajko commented Aug 21, 2023

I'd caution against doing this.

Firstly - "use tectonic to build the PDF" is a misleading way of saying "move from LaTeX to a new and experimental TeX variant". While Tectonic is marketed as a more modern way of building (La)TeX documents, it's actually more than that, it's yet another implementation of TeX, but one somewhat divorced from the common conventions underpinning the TeX ecosystems.

An analogy: adopting Tectonic for building the PDF docs would be like adopting a peculiar and nonstandard C compiler for building the parts of Julia implemented in C/C++. While this seems harsh, it is perhaps even charitable to the option of moving to Tectonic.

From a TeX engine perspective, Tectonic is a fork of the long abandoned (but still used) TeX engine called XeTeX. The thing is, XeTeX wasn't abandoned just by its maintainers, it's also largely abandoned by the ecosystem of LaTeX packages and other TeX-related software. While XeTeX still "works" for some use cases to some degree, it seems to me that modern LaTeX packages usually don't support XeTeX, and it was always a quirky engine with compatibility issues, requiring special handling from both package and document authors. It's also of course missing features that are now expected by advanced users.

So moving to XeTeX would hamper relying on the rich TeX ecosystem.

@ViralBShah
Copy link
Member Author

That's useful background.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system upstream The issue is with an upstream dependency, e.g. LLVM
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants