module Doc:sig
..end
typechapter =
[ `Kernel | `Plugin of string | `Protocol ]
type
page
val path : page -> string
val href : page -> string -> Markdown.href
val chapter : page -> chapter
val page : chapter -> title:string -> filename:string -> page
The page initially contains an introductory section read from the share directory:
frama-c/share/protocol/<filename>
for protocol pages,frama-c/share/server/kernel/<filename>
for kernel pages,frama-c/share/<plugin>/server/<filename>
for plugin's pages.val publish : page:page ->
?name:string ->
?index:string list ->
title:string ->
?contents:Markdown.elements ->
?generated:(unit -> Markdown.elements) -> unit -> Markdown.href
val dump : root:string -> ?meta:bool -> unit -> unit
~meta:false
, also
generates METADATA for each page in <filename>.json
for each page.