JuliaDocs/Documenter.jl

Support Podman containers for building LaTeX/PDFs

Offen

#1.863 geöffnet am 04.07.2022

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: LaTeXType: Featurehelp wanted

Repository-Metriken

Stars
 (910 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Untersuche die Datei LaTeXWriter.jl, insbesondere um Zeile 58 und Zeile 200 herum, wo Docker Befehle zum Kompilieren von LaTeX verwendet werden. Verstehe die aktuelle Docker basierte Logik und implementiere dann einen alternativen Pfad mit Podman. Da Podman CLI kompatibel mit Docker ist, werden die Änderungen wahrscheinlich in Befehlszeichenfolgen oder Erkennungslogik liegen. Prüfe auf Umgebungsvariablen oder Konfigurationsoptionen. Das Issue hat 7 Kommentare; überprüfe sie auf vorgeschlagene Lösungen oder Feedback der Maintainer.
Tech Stack
docker
Domain
developer experiencetooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitJulia
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70