Example: Thesis Chapter

Academic chapter with sections, citations, formulas, index entries, and an embedded diagram.

thesis_chapter.py

import engrapha_notes as en
import engrapha_diagrams as ed

en.set_theme(en.DARK)
en.set_global_header(left="Thesis", center="Chapter 3", right="Draft 0.1")

en.chap_box("3. Distributed Consensus via Raft")

en.body(
    "Raft achieves consensus by electing a single leader that manages "
    "replicated log entries. Safety is guaranteed by the restriction that "
    "only the current leader can commit entries."
)

en.index_entry("Raft")
en.index_entry("Consensus")

en.section("Leader Election")

en.body(
    "Quotes from Ongaro and Ousterhout [1] describe randomised election "
    "timeouts as the mechanism for split-vote resolution."
)

# Inline formula + advanced paragraph
en.body(
    "The election timeout range is typically chosen from \\\\(T \\in [150, 300] ms\\\\) "
    "to reduce collision probability."
)

en.section("Log Replication")

# Diagram
seq = ed.SequenceDiagram(
    width=340, height=200,
    caption="Fig 3.1: Client request → majority commit",
)
seq.actor("client", "Client")
seq.actor("ldr",    "Leader")
seq.actor("f1",     "Follower 1")
seq.actor("f2",     "Follower 2")

seq.message("client", "ldr", "PUT x=1")
seq.activate("ldr")
seq.message("ldr", "f1", "Append RPC")
seq.message("ldr", "f2", "Append RPC")
seq.message("f2", "ldr", "ACK", arrow="dashed")
seq.message("f1", "ldr", "ACK", arrow="dashed")
seq.message("ldr", "client", "COMMIT", arrow="dashed")
seq.deactivate("ldr")

en.add(seq.as_flowable())

# References section
en.section("References")
en.body("[1] Diego Ongaro and John Ousterhout. *In Search of an Understandable Consensus Algorithm.* USENIX ATC 2014.")

en.build_doc("thesis_chapter.pdf")