package odig

You can search for identifiers within the package.

in-package search v0.2.0

Lookup documentation of installed OCaml packages

Install

Dune Dependency

erratique.ch Readme Changelog ISC; PT-Sans-fonts; DejaVu-fonts License Edit opam file Versions (7)

Authors

T

The odig programmers

Maintainers

Daniel Bünzli

Sources

odig-0.0.4.tbz

sha256=317bff8108f310ba14b435162f27921fb21f4f8a522121b1388b26b1515c496d

md5=cea6608b4d0a62df5c358d771fd1a148

doc/odig_support/Odig_odoc/index.html

Module `Odig_odoc`

odoc API reference generation.

This mainly implements an odoc file resolution and generation request procedure specific to odig. Generic odoc driving bits are provided via B0_odoc.

val set_theme : 
  Odig_support.Conf.t ->
  Odig_support.Odoc_theme.t ->
  (unit, string) Stdlib.result

set_theme t sets theme odoc_theme in configuration conf.

val gen : 
  Odig_support.Conf.t ->
  force:bool ->
  index_title:string option ->
  index_intro:B0_std.Fpath.t option ->
  pkg_deps:bool ->
  tag_index:bool ->
  Odig_support.Pkg.t list ->
  (unit, string) Stdlib.result

gen c ~force ~index_intro ~pkg_deps ~tag_index pkgs generates API reference for packages pkgs.

index_title is the title of the page with the list of packages.
index_intro if specified is an mld file to define the introduction of the page with the list of packages.
pkg_deps if true dependencies of pkgs are also generated. If false only pkgs are generated which may lead to broken links in the output.
tag_index if true a tag index is generated on the package list page and package pages hyperlink into it from the package information section.