Module Server_doc

module Server_doc: sig .. end

Server Documentation

type chapter = [ `Kernel | `Plugin of string | `Protocol ]

The main chapters of the documentation.

type page

A page of the server documentation.

val path : page -> string

val href : page -> string -> Markdown.href

val chapter : page -> chapter

val page : chapter ->
       title:string ->
       ?descr:Markdown.elements ->
       ?readme:string -> filename:string -> unit -> page

Obtain the given page in the server documentation.

The readme introductory section is read from the share directory:

frama-c/share/<filename> server and 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

Adds a section in the corresponding page. Returns an href to the published section. If index items are provided, they are added to the server documentation index.

val protocole : title:string -> readme:string -> unit

Publish a protocole.

val package : Package.packageInfo -> unit

Publish a package.

val dump : root:Filepath.Normalized.t -> ?meta:bool -> unit -> unit

Dumps all published pages of documentations. Unless ~meta:false, also generates METADATA for each page in <filename>.json for each page.