package b0

You can search for identifiers within the package.

in-package search v0.2.0

On This Page

HTML generation

package b0

b0.b00
- B00
  - Env
  - Exec
  - File_cache
    
    Stats
  - Guard
  - Memo
    
    Fut
  - Op
    
    Map
    
    Mkdir
    
    Read
    
    Set
    
    Spawn
    
    Write
  - Op_cache
  - Tool
b0.care
- B0_github
  - Issue
  - Pages
  - Release
  - Repo
- B0_machine
- B0_odoc
  - Compile
    
    Dep
    
    Writes
  - Html
    
    Dep
    
    Writes
  - Html_fragment
  - Support_files
    
    Writes
- B0_trace
  - Compilation_database
  - Trace_event
- B0_ui
  - Browser
  - Cli
    
    Arg
    
    B0_std
  - Editor
  - Memo
  - Pager
- B0_vcs
  - Git
- B0_web
  - Htmlg
    
    Att
    
    El
  - Http
  - Json
  - Jsong
  - Jsonq
b0.std
- B0_std
  - Char
    
    Ascii
  - Cmd
  - Conv
    
    Bin
    
    Txt
  - Fmt
  - Fpath
    
    Map
    
    Set
  - Hash
    
    Murmur3_128
    
    T
    
    Xxh_64
  - List
  - Log
  - Option
  - Os
    
    Cmd
    
    Dir
    
    Env
    
    Fd
    
    File
    
    Path
  - Result
  - String
    
    Ascii
    
    Map
    
    Set
  - Time
    
    Span
  - Tty

Legend:
Library
Module
Module type
Parameter
Class
Class type

Generate HTML from .odoc files.

HTML generation

module Dep : sig ... end

HTML generation dependencies, for compiling a package (sic) to HTML files.

module Writes : sig ... end

HTML generation writes, files written by generating HTML files from an .odoc file.

val cmd : 
  ?hidden:bool ->
  ?theme_uri:string ->
  B00.Memo.t ->
  odoc_deps:B0_std.Fpath.t list ->
  writes:B0_std.Fpath.t list ->
  B0_std.Fpath.t ->
  to_dir:B0_std.Fpath.t ->
  unit

cmd m ~hidden ~theme_uri ~odoc_deps ~writes odoc ~to_dir generates HTML for the .odoc file odoc to output directory to_dir with the odoc html command.

odoc_deps are the .odoc file dependencies for the odoc file, they can be obtained by resolving the result of Dep on the package odoc directory of odoc.
writes specifies the writes of the command, they can be obtained via Writes.
theme_uri and hidden are the corresponding odoc options. See odoc compile --help.