rules_tectonic

Bazel rules to compile LaTeX into PDFs via tectonic.

bazel_dep(name = "rules_tectonic", version = "0.2.0")

View source & releases on GitHub ↗

Bazel rules to compile LaTeX → PDF using tectonic, the modern, self-bootstrapping TeX engine. Prebuilt release binaries are fetched per host platform via rules_github; no system LaTeX install required.

Install

Add the fastverk registry to your .bazelrc:

common --registry=https://registry.fastverk.com/
common --registry=https://bcr.bazel.build/

In your MODULE.bazel:

bazel_dep(name = "rules_tectonic", version = "0.1.0")

tectonic = use_extension("@rules_tectonic//tectonic:extensions.bzl", "tectonic")
use_repo(tectonic, "tectonic")
register_toolchains("@tectonic//:tectonic_toolchain_def")

Quick start

load("@rules_tectonic//tectonic:defs.bzl", "tectonic_pdf")

tectonic_pdf(
    name = "paper",
    main = "main.tex",
    srcs = [
        "arxiv.sty",
        "figs/loss_curve.png",
        "refs.bib",
    ],
)

bazel build //paper:paper writes paper.pdf into bazel-bin.

Pinning a non-default version

tectonic = use_extension("@rules_tectonic//tectonic:extensions.bzl", "tectonic")
tectonic.toolchain(version = "0.15.0")
use_repo(tectonic, "tectonic")

The pinned version must have its per-platform sha256s recorded in tectonic/private/known_versions.bzl. PRs welcome to add newer releases.

Supported platforms

Windows is not currently supported by this module; PRs welcome.

Notes on hermeticity

Tectonic’s first build per Bazel output_base fetches font + class files from the tectonic bundle CDN (note: downloading cmr10.pfb…). These are cached at ~/.cache/Tectonic/; subsequent builds are fully offline. The action runs with use_default_shell_env = True so the cache is reused across invocations.

For strict-hermetic builds, pre-fetch the bundle as a http_archive and pass --web-bundle=file://... to tectonic. Not currently exposed; file an issue if needed.

License

Apache-2.0.

Usage#

load("@rules_tectonic//tectonic:defs.bzl", "tectonic_pdf")

# `bazel build //examples:smoke` from this repo's checkout proves the
# rule wires up end-to-end. Consumers don't need this target.
tectonic_pdf(
    name = "smoke",
    main = "smoke.tex",
)

load(
    "@rules_tectonic//tectonic:defs.bzl",
    "tex_paper",
    "tex_section",
)

# Smoke test for the v0.0.2 `tex_section` + `tex_paper` rules.
# Two sections in their own files, composed into a single PDF.
#
#   bazel build //examples/sectioned:sectioned_paper
#
# produces `sectioned_paper.pdf`.

tex_section(
    name = "intro",
    src = "intro.tex",
    section_label = "sec:intro",
)

tex_section(
    name = "body",
    src = "body.tex",
    section_label = "sec:body",
)

tex_paper(
    name = "sectioned_paper",
    preamble = "preamble.tex",
    sections = [
        ":intro",
        ":body",
    ],
)

Conformance#

Dependencies#

Depends on

Used by (5 in the registry)

Versions#

3 published versions, newest first. Each resolves to an immutable, integrity-checked archive.

Changelog#

← All modules