This extension adds support for citing IETF RFCs (Request for Comments) in odoc documentation. It provides a convenient way to reference internet standards with automatic linking and formatting.
opam install odoc-rfc-extensionOnce installed, the extension is automatically loaded by odoc.
Use the @rfc tag to cite an RFC:
(** See @rfc 5321 for SMTP details. *)
This creates a formatted citation with a link to the official RFC document.
Internet Protocol (IP):
Transmission Control Protocol (TCP):
User Datagram Protocol (UDP):
Domain Name System (DNS):
HTTP Semantics:
HTTP Caching:
JSON Web Token (JWT):
OAuth 2.0:
Internet Message Format:
IMAP IDLE:
IMAP CONDSTORE:
TLS 1.2:
TLS 1.3:
RFC citations are especially useful in API documentation:
(** Parse an email address according to @rfc 5322.
@raises Parse_error if the address is malformed *)
val parse : string -> tThe extension generates links to the official IETF datatracker:
https://datatracker.ietf.org/doc/html/rfc<number>
The citation is styled with a distinctive appearance to make RFC references easy to identify in documentation.