Module `Rfc_extension`Source

RFC extension for odoc.

Provides tags for linking to IETF RFCs:

@rfc 9110 - Link to RFC 9110
@rfc 9110 Section 5.5 - Link to RFC 9110 Section 5.5
@rfc 9110 section-5.5 - Link to RFC 9110 with anchor

The extension generates links to https://www.rfc-editor.org/rfc/rfcNNNN

Sourceval prefix : string

Sourceval rfc_css : string

CSS styles for RFC references

val parse_rfc_reference : 
  Odoc_extension_api.Comment.nestable_block_element
    Odoc_extension_api.Location_.with_location
    list ->
  string * [> `Anchor of string | `Section of string ] option

Parse RFC reference from tag content. Supports formats:

"9110" -> RFC 9110
"9110 Section 5.5" -> RFC 9110 Section 5.5
"9110 section-5.5" -> RFC 9110 with anchor #section-5.5
"RFC 9110" -> RFC 9110 (optional RFC prefix)

Source

val rfc_url : 
  string ->
  [< `Anchor of string | `Section of string ] option ->
  string

Generate URL for RFC reference

Source

val rfc_display_text : 
  string ->
  [< `Anchor of 'a | `Section of string ] option ->
  string

Generate display text for RFC reference

Source

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

Document phase - generate RFC link

Module Rfc_extensionSource

Module `Rfc_extension`Source