package odoc

You can search for identifiers within the package.

in-package search v0.2.0

package odoc

The odoc documentation generator
- odoc for Authors
- Cheatsheet
- Dune and odoc
- Language Features
- Markup Differences From OCamldoc
- odoc Interface Guarantees
- How to Drive odoc
- JSON output
- Deprecated features
  - Parent/Child Specification
- CHANGES
- README
- Library odoc.document
  - Odoc_document
    
    Codefmt
    
    Infix
    
    Comment
    
    Comment
    
    Reference
    
    Compat
    
    Format
    
    Doctree
    
    Take
    
    Rewire
    
    Toc
    
    Subpages
    
    Shift
    
    Headings
    
    Labels
    
    PageTitle
    
    Math
    
    Generator
    
    Make
    
    Generator_signatures
    
    Lang
    
    SYNTAX
    
    Obj
    
    Type
    
    Variant
    
    Tuple
    
    Record
    
    Exception
    
    GADT
    
    External
    
    Mod
    
    Class
    
    Value
    
    Comment
    
    GENERATOR
    
    ML
    
    Reason
    
    Renderer
    
    Sidebar
    
    Targets
    
    Types
    
    Class
    
    Link
    
    Target
    
    Raw_markup
    
    Source
    
    Math
    
    Inline
    
    Description
    
    Heading
    
    Block
    
    Table
    
    DocumentedSrc
    
    Alternative
    
    Subpage
    
    Include
    
    Item
    
    Page
    
    Source_page
    
    Document
    
    Url
    
    Path
    
    Anchor
    
    Utils
- Library odoc.examples
  - Odoc_examples
    
    Expansion
    
    Simple
    
    StringSet
    
    Aliases
    
    Alias
    
    ModuleTypeAliases
    
    A
    
    B
    
    ModuleTypeAliases2
    
    A
    
    A
    
    X
    
    B
    
    A
    
    X
    
    Functors
    
    Argument
    
    Result
    
    Functor
    
    Include
    
    ToBeIncluded
    
    A
    
    B
    
    Shadowing
    
    A
    
    B
    
    DeepEquality
    
    SIG
    
    MODTYPE
    
    X
    
    Y
    
    M
    
    X
    
    Y
    
    DeepEquality2
    
    MODTYPE
    
    X
    
    Y
    
    M
    
    X
    
    Y
    
    TypeSubstitution
    
    S
    
    M
    
    T
    
    M
    
    ModuleTypeOf
    
    A
    
    M
    
    M'
    
    ModuleTypeOfComplications
    
    S
    
    X
    
    Y
    
    Z
    
    X1
    
    T
    
    Y
    
    Z
    
    Resolution
    
    Alias
    
    A
    
    B
    
    A
    
    B
    
    HiddenAlias
    
    B
    
    Canonical
    
    A
    
    B
    
    Fragments
    
    A
    
    B
    
    C
    
    B
    
    D
    
    Hidden
    
    References
    
    A
    
    A
    
    B
    
    B
    
    Complicated_1
    
    A
    
    M
    
    S
    
    N
    
    B
    
    S
    
    C
    
    M
    
    N
    
    Complicated_2
    
    Type
    
    T
    
    App
    
    Bar
    
    T
    
    Foo
    
    T
    
    Foo
    
    FooBarInt
    
    Foo
    
    Wrapping
    
    Markup
    
    Foo
    
    cl
    
    my_class
    
    my_class_type
    
    Foo
    
    my_module_type
    
    M
    
    Stop
    
    foo
    
    Scope
    
    A
    
    Preamble_examples
    
    Module
    
    Module2
    
    Nonhidden_module
    
    Module3
    
    Nonhidden_module2
    
    Module4
- Library odoc.html
  - Odoc_html
    
    Types
    
    Config
    
    Html_fragment_json
    
    Html
    
    Html_page
    
    Html
    
    Generator
    
    Link
    
    Url
    
    Path
    
    Json
    
    Sidebar
- Library odoc.html_support_files
  - Odoc_html_support_files
    
    Internal
- Library odoc.index
  - Odoc_index
    
    Skeleton
    
    Entry
    
    Skeleton_of
- Library odoc.json_index
  - Odoc_json_index
    
    Json_display
    
    Json_search
- Library odoc.latex
  - Odoc_latex
    
    Generator
    
    Link
    
    Raw
    
    Escape
    
    Types
- Library odoc.loader
  - Odoc_loader
- Library odoc.manpage
  - Odoc_manpage
    
    Generator
    
    Link
- Library odoc.model
  - Odoc_model
    
    Lang
    
    Module
    
    Equation
    
    FunctorParameter
    
    ModuleType
    
    U
    
    ModuleSubstitution
    
    ModuleTypeSubstitution
    
    Signature
    
    Open
    
    Include
    
    TypeDecl
    
    Field
    
    Constructor
    
    Representation
    
    Equation
    
    Extension
    
    Constructor
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    ClassSignature
    
    Constraint
    
    Inherit
    
    Method
    
    InstanceVariable
    
    TypeExpr
    
    Polymorphic_variant
    
    Constructor
    
    Object
    
    Package
    
    Compilation_unit
    
    Import
    
    Source
    
    Packed
    
    Source_info
    
    Implementation
    
    Page
    
    Asset
    
    Comment
    
    Path
    
    Reference
    
    Identifier
    
    Paths
    
    Ocaml_ident
    
    Ocaml_env
    
    Identifier
    
    IdSig
    
    Id
    
    Any
    
    RootModule
    
    Signature
    
    ClassSignature
    
    LabelParent
    
    Module
    
    FunctorParameter
    
    ModuleType
    
    Type
    
    Class
    
    ClassType
    
    DataType
    
    FieldParent
    
    FunctorResult
    
    Constructor
    
    Field
    
    Extension
    
    ExtensionDecl
    
    Exception
    
    Value
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    LeafPage
    
    ContainerPage
    
    NonSrc
    
    SourcePage
    
    SourceLocation
    
    AssetFile
    
    OdocId
    
    Path
    
    Module
    
    ModuleType
    
    Type
    
    Value
    
    ClassType
    
    Maps
    
    Any
    
    FunctorParameter
    
    Module
    
    ModuleType
    
    Type
    
    Class
    
    ClassType
    
    Label
    
    Path
    
    Type
    
    ClassType
    
    Hashtbl
    
    Any
    
    ContainerPage
    
    LeafPage
    
    RootModule
    
    SourcePage
    
    Mk
    
    Path
    
    Resolved
    
    Module
    
    ModuleType
    
    Type
    
    Value
    
    ClassType
    
    Module
    
    ModuleType
    
    Type
    
    Value
    
    ClassType
    
    Fragment
    
    Resolved
    
    Signature
    
    Module
    
    ModuleType
    
    Type
    
    Signature
    
    Module
    
    ModuleType
    
    Type
    
    Reference
    
    Resolved
    
    Signature
    
    ClassSignature
    
    DataType
    
    FieldParent
    
    LabelParent
    
    Module
    
    ModuleType
    
    Type
    
    Constructor
    
    Field
    
    Extension
    
    ExtensionDecl
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    Asset
    
    Signature
    
    ClassSignature
    
    DataType
    
    FragmentTypeParent
    
    LabelParent
    
    Module
    
    ModuleType
    
    Type
    
    Constructor
    
    Field
    
    Extension
    
    ExtensionDecl
    
    Exception
    
    Value
    
    Class
    
    ClassType
    
    Method
    
    InstanceVariable
    
    Label
    
    Page
    
    Asset
    
    Hierarchy
    
    Names
    
    Name
    
    SimpleName
    
    ModuleName
    
    ModuleTypeName
    
    TypeName
    
    ConstructorName
    
    FieldName
    
    ExtensionName
    
    ExceptionName
    
    ValueName
    
    MethodName
    
    InstanceVariableName
    
    LabelName
    
    PageName
    
    DefName
    
    LocalName
    
    AssetName
    
    Root
    
    Package
    
    Odoc_file
    
    Hash_table
    
    Error
    
    Location_
    
    Compat
    
    Semantics
    
    Reference
    
    Frontmatter
- Library odoc.model_desc
  - Odoc_model_desc
    
    Comment_desc
    
    Lang_desc
    
    T
    
    Digest
    
    Paths_desc
    
    Type_desc
- Library odoc.ocamlary
  - Ocamlary
    
    Empty
    
    Empty
    
    MissingComment
    
    EmptyAlias
    
    EmptySig
    
    EmptySigAlias
    
    ModuleWithSignature
    
    ModuleWithSignatureAlias
    
    One
    
    SigForMod
    
    Inner
    
    Empty
    
    SuperSig
    
    SubSigA
    
    SubSigAMod
    
    SubSigB
    
    EmptySig
    
    One
    
    SuperSig
    
    Buffer
    
    CollectionModule
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    COLLECTION
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    Recollection
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    MMM
    
    C
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    RECOLLECTION
    
    C
    
    RecollectionModule
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    A
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    B
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    C
    
    Q
    
    InnerModuleA
    
    InnerModuleA'
    
    InnerModuleTypeA'
    
    InnerModuleTypeA
    
    FunctorTypeOf
    
    IncludeModuleType
    
    ToInclude
    
    IncludedA
    
    IncludedB
    
    IncludedA
    
    IncludedB
    
    ExtMod
    
    empty_class
    
    one_method_class
    
    two_method_class
    
    param_class
    
    Dep1
    
    S
    
    c
    
    X
    
    Y
    
    c
    
    Dep2
    
    A
    
    Y
    
    B
    
    Dep3
    
    Dep4
    
    T
    
    S
    
    X
    
    Y
    
    X
    
    Dep5
    
    Z
    
    X
    
    Y
    
    Dep6
    
    S
    
    T
    
    R
    
    Y
    
    X
    
    R
    
    Y
    
    Dep7
    
    M
    
    R
    
    Y
    
    Dep8
    
    T
    
    Dep9
    
    T
    
    Dep10
    
    Dep11
    
    S
    
    c
    
    Dep12
    
    T
    
    Dep13
    
    c
    
    With1
    
    M
    
    S
    
    N
    
    With2
    
    S
    
    With3
    
    M
    
    N
    
    With4
    
    N
    
    With5
    
    S
    
    N
    
    With6
    
    T
    
    M
    
    S
    
    N
    
    With7
    
    T
    
    With8
    
    M
    
    S
    
    N
    
    With9
    
    S
    
    With10
    
    T
    
    M
    
    S
    
    N
    
    With11
    
    M
    
    N
    
    NestedInclude1
    
    NestedInclude2
    
    NestedInclude2
    
    DoubleInclude1
    
    DoubleInclude2
    
    DoubleInclude3
    
    DoubleInclude2
    
    IncludeInclude1
    
    IncludeInclude2
    
    IncludeInclude2_M
    
    IncludeInclude2
    
    IncludeInclude2_M
    
    CanonicalTest
    
    Base
    
    List
    
    Base_Tests
    
    C
    
    L
    
    List_modif
    
    Aliases
    
    Foo
    
    A
    
    B
    
    C
    
    D
    
    E
    
    A'
    
    Std
    
    A
    
    B
    
    C
    
    D
    
    E
    
    A
    
    B
    
    C
    
    D
    
    E
    
    P1
    
    Y
    
    P2
    
    Z
    
    X1
    
    X2
    
    M
    
    M
    
    Only_a_module
    
    TypeExt
    
    TypeExtPruned
    
    Op
- Library odoc.occurrences
  - Odoc_occurrences
    
    Table
- Library odoc.odoc
  - Odoc_odoc
    
    Asset
    
    Classify
    
    StringSet
    
    Archive
    
    Cmi
    
    Deps
    
    Compile
    
    Depends
    
    Compile
    
    Extract_code
    
    Fs
    
    Directory
    
    Table
    
    File
    
    Table
    
    Html_fragment
    
    Html_page
    
    Indexing
    
    Latex
    
    Man_page
    
    Occurrences
    
    Odoc_file
    
    Odoc_link
    
    Or_error
    
    Rendering
    
    Resolver
    
    Sidebar
    
    Source
    
    Support_files
    
    Url
- Library odoc.odoc_utils
  - Odoc_utils
    
    ResultMonad
    
    OptionMonad
    
    EitherMonad
    
    List
    
    Option
    
    Result
    
    Fun
    
    Tree
    
    S
    
    Forest
    
    Forest
    
    Json
    
    Io_utils
    
    Char
    
    String
- Library odoc.search
  - Odoc_search
    
    Html
    
    Text
- Library odoc.search_html_frontend
  - Odoc_html_frontend
- Library odoc.syntax_highlighter
  - Syntax_highlighter
- Library odoc.xref2
  - Odoc_xref2
    
    Cfrag
    
    Compile
    
    Component
    
    ModuleMap
    
    TypeMap
    
    ModuleTypeMap
    
    ValueMap
    
    IdentMap
    
    Delayed
    
    Opt
    
    Module
    
    ModuleSubstitution
    
    ModuleTypeSubstitution
    
    TypeExpr
    
    Polymorphic_variant
    
    Constructor
    
    Object
    
    Package
    
    Extension
    
    Constructor
    
    Exception
    
    FunctorParameter
    
    ModuleType
    
    U
    
    TypeDecl
    
    Field
    
    Constructor
    
    Representation
    
    Equation
    
    Signature
    
    Open
    
    Include
    
    Value
    
    Class
    
    ClassType
    
    ClassSignature
    
    Constraint
    
    Inherit
    
    Method
    
    InstanceVariable
    
    Substitution
    
    CComment
    
    Label
    
    Element
    
    Fmt
    
    Of_Lang
    
    Cpath
    
    Resolved
    
    Cpath
    
    Env
    
    LookupTypeSet
    
    Errors
    
    Tools_error
    
    Expand_tools
    
    Find
    
    Ident
    
    Of_Identifier
    
    Name
    
    Rename
    
    Lang_of
    
    Opt
    
    Path
    
    Link
    
    Lookup_failures
    
    Ref_tools
    
    Shape_tools
    
    Strengthen
    
    Subst
    
    Tools
- Library odoc.xref_test
  - Odoc_xref_test
    
    Common
    
    Ident
    
    LangUtils
    
    Lens
    
    Signature
    
    Module
    
    Include
    
    ModuleType
    
    FunctorParameter
    
    TypeDecl
    
    Equation
    
    TypeExpr
    
    Lookup
    
    Fmt
- Sources
  - odoc.document
    
    ML.ml
    
    codefmt.ml
    
    comment.ml
    
    compat.ml
    
    doctree.ml
    
    generator.ml
    
    generator_signatures.ml
    
    odoc_document.ml
    
    reason.ml
    
    renderer.ml
    
    sidebar.ml
    
    targets.ml
    
    types.ml
    
    url.ml
    
    utils.ml
  - odoc.examples
    
    odoc_examples.ml
    
    odoc_examples__.ml
  - odoc.html
    
    config.ml
    
    generator.ml
    
    html_fragment_json.ml
    
    html_page.ml
    
    html_source.ml
    
    link.ml
    
    odoc_html.ml
    
    odoc_html__.ml
    
    sidebar.ml
    
    types.ml
  - odoc.html_support_files
    
    odoc_html_support_files.ml
  - odoc.index
    
    entry.ml
    
    in_progress.ml
    
    odoc_index.ml
    
    odoc_index__.ml
    
    skeleton.ml
    
    skeleton_of.ml
  - odoc.json_index
    
    json_display.ml
    
    json_search.ml
    
    odoc_json_index.ml
  - odoc.latex
    
    generator.ml
    
    odoc_latex.ml
    
    raw.ml
    
    types.ml
  - odoc.loader
    
    cmi.ml
    
    cmt.ml
    
    cmti.ml
    
    doc_attr.ml
    
    ident_env.ml
    
    implementation.ml
    
    odoc_loader.ml
    
    odoc_loader__.ml
    
    typedtree_traverse.ml
  - odoc.manpage
    
    generator.ml
    
    link.ml
    
    odoc_manpage.ml
  - odoc.model
    
    comment.ml
    
    compat.ml
    
    error.ml
    
    frontmatter.ml
    
    lang.ml
    
    location_.ml
    
    names.ml
    
    odoc_model.ml
    
    odoc_model__.ml
    
    paths.ml
    
    paths_types.ml
    
    reference.ml
    
    root.ml
    
    semantics.ml
  - odoc.model_desc
    
    comment_desc.ml
    
    lang_desc.ml
    
    odoc_model_desc.ml
    
    paths_desc.ml
    
    type_desc.ml
  - odoc.occurrences
    
    odoc_occurrences.ml
    
    odoc_occurrences__.ml
    
    table.ml
  - odoc.odoc
    
    asset.ml
    
    classify.ml
    
    compile.ml
    
    depends.ml
    
    extract_code.ml
    
    fs.ml
    
    html_fragment.ml
    
    html_page.ml
    
    indexing.ml
    
    latex.ml
    
    man_page.ml
    
    occurrences.ml
    
    odoc_file.ml
    
    odoc_link.ml
    
    odoc_odoc.ml
    
    or_error.ml
    
    rendering.ml
    
    resolver.ml
    
    sidebar.ml
    
    source.ml
    
    support_files.ml
    
    url.ml
  - odoc.odoc_utils
    
    json.ml
    
    odoc_list.ml
    
    odoc_utils.ml
    
    odoc_utils__.ml
    
    tree.ml
  - odoc.search
    
    html.ml
    
    odoc_search.ml
    
    text.ml
  - odoc.search_html_frontend
    
    odoc_html_frontend.ml
  - odoc.syntax_highlighter
    
    syntax_highlighter.ml
  - odoc.xref2
    
    cfrag.ml
    
    compile.ml
    
    component.ml
    
    cpath.ml
    
    env.ml
    
    errors.ml
    
    expand_tools.ml
    
    find.ml
    
    ident.ml
    
    lang_of.ml
    
    link.ml
    
    lookup_failures.ml
    
    odoc_xref2.ml
    
    ref_tools.ml
    
    shape_tools.ml
    
    strengthen.ml
    
    subst.ml
    
    tools.ml
  - odoc.xref_test
    
    common.ml
    
    odoc_xref_test.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Odoc_document.Reason`Source

Sourceval compilation_unit : Odoc_model.Lang.Compilation_unit.t -> Types.Document.t

Sourceval page : Odoc_model.Lang.Page.t -> Types.Document.t

Convert compilation unit or page models into a document

Source

val implementation : 
  Odoc_model.Lang.Implementation.t ->
  Syntax_highlighter.infos ->
  string ->
  Types.Document.t list

Highlight the source as OCaml syntax

package odoc

Module Odoc_document.ReasonSource

Module `Odoc_document.Reason`Source