package odig

  1. Overview
  2. Docs
Lookup documentation of installed OCaml packages

Install 

dune-project
 Dependency

erratique.ch Readme Changelog ISC; LicenseRef-ParaType-Free-Font-License; LicenseRef-DejaVu-fonts License Edit opam file Versions (2)

Authors

  1. T
    The odig programmers

Maintainers

  1. Daniel Bünzli

Sources

odig-0.1.0.tbz
sha512=acabe752f5010900e9fe024321d6e34cc07f395ebd18f015a00b88c4c6482645b591a83a3f088f110adaf83e062551feb800a1dbca7646cce305eb3f542cfa41

doc/odig_support/Odig_support/Doc_dir/index.html

Module Odig_support.Doc_dirSource

Lookup package documentation directory.

Package documentation directory

Sourcetype t

The type for documentation directory information.

Sourceval dir : t -> B0_std.Fpath.t option

dir is the path to the documentation directory (if any).

Sourceval changes_files : t -> B0_std.Fpath.t list

changes_files i are the package's change log files.

Sourceval license_files : t -> B0_std.Fpath.t list

license_files i are the package's licenses files.

Sourceval odoc_pages : t -> B0_std.Fpath.t list

odoc_pages i are the package's odoc pages

Sourceval odoc_assets_dir : t -> B0_std.Fpath.t option

odoc_assets i is the package's odoc assets directory (if any).

Sourceval odoc_assets : t -> B0_std.Fpath.t list

odoc_assets i is the package's odoc assets directory contents.

Sourceval readme_files : t -> B0_std.Fpath.t list

readme_files i are the package's readme files.

Queries

Sourceval of_pkg : doc_dir:B0_std.Fpath.t -> Pkg.t -> t

query ~doc_dir pkg queries the documentation directory doc_dir for documentation about pkg.