package odig

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

Pages

package odig

odig.support
- Odig_odoc
- Odig_odoc_page
- Odig_support
  - Conf
  - Digest
  - Doc_cobj
  - Doc_dir
  - Env
  - Opam
  - Pkg
  - Pkg_info

Legend:
Library
Module
Module type
Parameter
Class
Class type

mld and HTML pages generated by odig itself.

Pages

val index_mld : 
  Odig_support.Conf.t ->
  Odig_support.Pkg.t ->
  Odig_support.Pkg_info.t ->
  user_index:string option ->
  with_tag_links:bool ->
  string

index_mld conf pkg pkg_info ~user_index ~with_tag_links is an index.mld page for package pkg with info pkg_info.

If user_index is Some content, that user provided content is integrated in the result (a leading section "{0" is stripped away though) and no module index is generated by the function.
with_tag_links, if true assumes the package list generated by pkg_list has a tag index and links the tags of the metadata section into it.

val pkgs_with_html_docs : Odig_support.Conf.t -> Odig_support.Pkg.t list

pkg_with_html_docs c looks up in c packages that seem to have generated documentation.

val pkg_list : 
  Odig_support.Conf.t ->
  index_title:string option ->
  raw_index_intro:string option ->
  raw_index_toc:string option ->
  tag_index:bool ->
  ocaml_manual_uri:string option ->
  Odig_support.Pkg.t list ->
  string

pkg_list c ~index_title ~raw_index_intro ~tag_index ~ocaml_manual_uri pkgs is an HTML page package list for the packages pkgs.

index_title is a title for the page with the list of packages; if unspecified one is automatically generated.
raw_index_intro is the HTML markup that is inserted before the list of packages; if unspecified one is automatically generated.
raw_index_toc is the HTML markup that is inserted in the toc list of packages page; if unspecified one is automatically generated.
tag_index if true a package tag is added to the page after the list of packages by name.
ocaml_manual_uri is a local URI to the OCaml manual if unspecified the online manual is linked.