Module type `Odoc_extension_api.Extension_with_link`Source

Extensions that also need link-time access to the cross-reference environment implement this extended signature.

include Odoc_extension_api.Extension

Sourceval prefix : string

The tag prefix this extension handles. E.g., "note" handles @note, "admonition" handles @admonition.note

val to_document : 
  tag:string ->
  Comment.nestable_block_element Location_.with_location list ->
  Odoc_extension_api.extension_output

Document phase: convert tag to renderable content. Called during document generation. Returns content plus any page-level resources needed (JS/CSS).

Source

val link : 
  tag:string ->
  Env.t ->
  Comment.nestable_block_element Location_.with_location list ->
  Comment.nestable_block_element Location_.with_location list

Link phase: transform tag content with access to the cross-reference environment. Called during linking, after references have been resolved. Use Env.lookup_page_by_name etc. to look up other pages.

Module type Odoc_extension_api.Extension_with_linkSource

Module type `Odoc_extension_api.Extension_with_link`Source