ci: add CI and GitHub Pages documentation workflows

This commit is contained in:
2026-10-23 16:38:24 +02:00
committed by owenrees
parent 786bad8956
commit 2bf11e92a8
16 changed files with 169 additions and 38 deletions
+11 -12
View File
@@ -1,33 +1,32 @@
(** Convert chess PGN games to LaTeX.
[Pgn_to_tex] is the public entry point for the library. Open it to convert
a PGN string without referring to any internal parsing or rendering
modules:
[Pgn_to_tex] is the public entry point for the library. Open it to convert a
PGN string without referring to any internal parsing or rendering modules:
{[
let tex = Pgn_to_tex.to_tex pgn
let tex = Pgn_to_tex.to_tex pgn
]}
Diagrams are optional and selected by passing {!diagram_data} built with
{!empty_diagrams} or {!parse_diagrams_json}. *)
type diagram_data
(** Diagram selection data.
The representation is intentionally abstract; construct values with
{!empty_diagrams} or {!parse_diagrams_json}. *)
type diagram_data
val empty_diagrams : diagram_data
(** [empty_diagrams] selects no diagrams. It is the default used by
{!to_tex}. *)
(** [empty_diagrams] selects no diagrams. It is the default used by {!to_tex}.
*)
val parse_diagrams_json : string -> diagram_data
(** [parse_diagrams_json json] parses diagram selections from a JSON string.
The input is expected to be a JSON array of objects. Each object contains
a [fen] string and either a legacy [ply] number, a [path] array of SAN
moves, or both. A matching [path] takes precedence; [ply] is the fallback
for mainline positions. Malformed JSON yields {!empty_diagrams} rather than
The input is expected to be a JSON array of objects. Each object contains a
[fen] string and either a legacy [ply] number, a [path] array of SAN moves,
or both. A matching [path] takes precedence; [ply] is the fallback for
mainline positions. Malformed JSON yields {!empty_diagrams} rather than
raising. *)
val to_tex : ?diagram_data:diagram_data -> ?clock:bool -> string -> string
@@ -38,4 +37,4 @@ val to_tex : ?diagram_data:diagram_data -> ?clock:bool -> string -> string
@param clock
when [true], render clock times alongside diagrams; defaults to [false].
@raise Failure "Parse error" if [pgn] is not a valid PGN game. *)
Raises [Failure "Parse error"] if [pgn] is not a valid PGN game. *)