Server.Server_doc
Server Documentation
val path : page -> string
val href : page -> string -> Frama_c_kernel.Markdown.href
val page :
chapter ->
title:string ->
?descr:Frama_c_kernel.Markdown.elements ->
?plugin:Package.plugin ->
readme:string option ->
filename:string ->
unit ->
page
Obtain the given page in the server documentation.
The readme introductory section is read from the source directory:
src/plugins/server/<filename>
server and kernel pages,src/plugins/<plugin>/<filename>
for plugin's pages.val publish :
page:page ->
?name:string ->
?index:string list ->
title:string ->
?contents:Frama_c_kernel.Markdown.elements ->
?generated:(unit -> Frama_c_kernel.Markdown.elements) ->
unit ->
Frama_c_kernel.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 package : Package.packageInfo -> unit
Publish a package.
val dump :
root:Frama_c_kernel.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.