Module `Doctree.Shift`Source

Sourcetype state = {

englobing_level : int;
current_level : int;

}

Sourceval start : Odoc_document.Doctree.Shift.state

val shift : 
  Odoc_document.Doctree.Shift.state ->
  int ->
  Odoc_document.Doctree.Shift.state * int

Source

val enter : 
  Odoc_document.Doctree.Shift.state ->
  int ->
  Odoc_document.Doctree.Shift.state

Source

val walk_documentedsrc : 
  on_sub:
    ([> `Include of Odoc_document.Types.Include.t
     | `Page of Odoc_document.Types.Subpage.t ] ->
      int option) ->
  Odoc_document.Doctree.Shift.state ->
  Odoc_document.Types.DocumentedSrc.t ->
  Odoc_document.Types.DocumentedSrc.t

Source

val subpage : 
  on_sub:
    ([> `Include of Odoc_document.Types.Include.t
     | `Page of Odoc_document.Types.Subpage.t ] ->
      int option) ->
  Odoc_document.Doctree.Shift.state ->
  Odoc_document.Types.Subpage.t ->
  Odoc_document.Types.Subpage.t

Source

val include_ : 
  on_sub:
    ([> `Include of Odoc_document.Types.Include.t
     | `Page of Odoc_document.Types.Subpage.t ] ->
      int option) ->
  Odoc_document.Doctree.Shift.state ->
  Odoc_document.Types.Include.t ->
  Odoc_document.Types.Include.t

Source

val walk_item : 
  on_sub:
    ([> `Include of Odoc_document.Types.Include.t
     | `Page of Odoc_document.Types.Subpage.t ] ->
      int option) ->
  Odoc_document.Doctree.Shift.state ->
  Odoc_document.Types.Item.t list ->
  Odoc_document.Types.Item.t list

Source

val compute : 
  on_sub:
    ([> `Include of Odoc_document.Types.Include.t
     | `Page of Odoc_document.Types.Subpage.t ] ->
      int option) ->
  Odoc_document.Types.Item.t list ->
  Odoc_document.Types.Item.t list

Module Doctree.ShiftSource

Module `Doctree.Shift`Source