JuliaDocs/Documenter.jl

Support Podman containers for building LaTeX/PDFs

Open

#1,863 opened on Jul 4, 2022

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Format: LaTeXType: Featurehelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (Avg merge 16d 9h) (3 merged PRs in 30d)

Description

Awesome work on Documenter.jl,

Using docker could be difficult due to root, so could it be possible to add Podman platform as an alternative to docker in LatexWriter.jl:

compile_tex(doc::Documents.Document, settings::LaTeX, fileprefix::String) from Documenter.jl/src/Writers/LaTeXWriter.jl

https://github.com/JuliaDocs/Documenter.jl/blob/2bcc94cbba6de049dc53d6ee453a301fe474ead2/src/Writers/LaTeXWriter.jl#L58

https://github.com/JuliaDocs/Documenter.jl/blob/2bcc94cbba6de049dc53d6ee453a301fe474ead2/src/Writers/LaTeXWriter.jl#L200

Regards

Contributor guide

Research direction
Examine the LaTeXWriter.jl file, specifically the compile tex function, to understand how Docker is invoked. Then implement a similar approach for Podman, possibly by detecting the available container runtime or making a configuration option.
Tech stack
docker
Domain
developer experiencetooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitJulia
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70