Skip to content

Make docs build less platform-dependent #808

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Sep 10, 2025
Merged

Make docs build less platform-dependent #808

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1276b44
Use Ghostscript_jll
Ickaser Sep 3, 2025
c22af3f
Ghostscript added as dep to Latexify, no need to specify it here
Ickaser Sep 3, 2025
965878e
Use Fontconfig to avoid the need for a font install
Ickaser Sep 4, 2025
7fc72e5
Now that it's released, update Latexify compat
Ickaser Sep 4, 2025
3bb0dda
Turn off fancy exponents for docs build, don't display latex images
Ickaser Sep 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/documentation.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- run: sudo apt install -y ghostscript fonts-freefont-ttf
- uses: julia-actions/setup-julia@v2
with:
version: 1
Expand Down
4 changes: 3 additions & 1 deletion docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[deps]
Dates = "ade2ca70-3891-5945-98fb-dc099432e06a"
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Fontconfig = "186bb1d3-e1f7-5a2c-a377-96d770f13627"
InverseFunctions = "3587e190-3f89-42d0-90ee-14403ec27112"
LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
Latexify = "23fbe1c1-3f47-55db-b15f-69d7ec21a316"
Expand All @@ -14,5 +15,6 @@ Unitful = {path = ".."}

[compat]
Documenter = "1"
Latexify = "0.16.9"
Latexify = "0.16.10"
Plots = "1"
Fontconfig = "0.4"
20 changes: 15 additions & 5 deletions docs/generate_latex_images.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
using LaTeXStrings, Unitful, Latexify, tectonic_jll
using LaTeXStrings, Unitful, Latexify
import tectonic_jll # needed for lightweight LaTeX render
using Fontconfig: format, match, Pattern

# Since the docs can get built on different systems, we need to find a locally installed
# monospaced font that has enough Unicode coverage to handle π
monofont = format(match(Pattern(spacing=100, charset="3c0")), "%{family}")

commands = [
:(latexify(612.2u"nm")),
Expand All @@ -19,11 +25,16 @@ end
ltab1 = latextabular(tab1, adjustment=:l, transpose=true, latex=false, booktabs=true,
head=["julia", "\\LaTeX", "Result"])
# Setting an explicit white background color results in transparent PDF, so go offwhite.
ltab1 = LaTeXString("\\definecolor{offwhite}{rgb}{0.999,0.999,0.999}\n\\pagecolor{offwhite}\n\\color{black}\n" * ltab1)
ltab1 = LaTeXString("""
\\setmonofont{$monofont}
\\definecolor{offwhite}{rgb}{0.999,0.999,0.999}
\\pagecolor{offwhite}
\\color{black}
""" * ltab1)

render(ltab1, MIME("image/png"); use_tectonic=true,
name=(@__DIR__)*"/src/assets/latex-examples",
packages=["booktabs", "color", "siunitx"],
packages=["booktabs", "color", "siunitx", "fontspec"],
documentclass=("standalone"))

functions = [
Expand Down Expand Up @@ -133,8 +144,7 @@ ltab2 = latextabular(tab2, adjustment=:l, transpose=true, latex=false, booktabs=
# Set background to not-quite-white so it doesn't get treated as transparent
ltab2 = LaTeXString(
"""
\\setmainfont{FreeSerif}
\\setmonofont{FreeMono}
\\setmonofont{$monofont}
\\definecolor{offwhite}{rgb}{0.999,0.999,0.999}
\\pagecolor{offwhite}
\\color{black}
Expand Down
Loading