Fix odoc heading level errors

Uniformly across all modules

Signed-off-by: Marcello Seri <[email protected]>

src/base/algodiff/owl_algodiff_core_sig.ml

@@ -6,11 +6,11 @@
 module type Sig = sig
   module A : Owl_types_ndarray_algodiff.Sig
 
-  (** {6 Type definition} *)
+  (** {5 Type definition} *)
 
   include Owl_algodiff_types_sig.Sig with type elt := A.elt and type arr := A.arr
 
-  (** {6 Core functions} *)
+  (** {5 Core functions} *)
 
   val tag : unit -> int
   (** TODO *)

src/base/algodiff/owl_algodiff_generic_sig.ml

@@ -92,7 +92,7 @@ module type Sig = sig
        and type arr := A.arr
        and type op := op
 
-  (** {6 Helper functions} *)
+  (** {5 Helper functions} *)
 
   include Owl_algodiff_graph_convert_sig.Sig with type t := t
 end

src/base/algodiff/owl_algodiff_ops_sig.ml

@@ -14,15 +14,15 @@ module type Sig = sig
 
   type op
 
-  (** {6 Ops Builder } *)
+  (** {5 Ops Builder } *)
   module Builder :
     Owl_algodiff_ops_builder_sig.Sig
       with type t := t
        and type elt := elt
        and type arr := arr
        and type op := op
 
-  (** {6 Supported Maths functions} *)
+  (** {5 Supported Maths functions} *)
 
   module Maths : sig
     val ( + ) : t -> t -> t
@@ -254,7 +254,7 @@ module type Sig = sig
     (** Refer to :doc:`owl_dense_ndarray_generic` *)
   end
 
-  (** {6 Supported Linalg functions} *)
+  (** {5 Supported Linalg functions} *)
 
   module Linalg : sig
     val inv : t -> t
@@ -294,7 +294,7 @@ module type Sig = sig
     (** Refer to :doc:`owl_dense_ndarray_generic` *)
   end
 
-  (** {6 Supported Neural Network functions} *)
+  (** {5 Supported Neural Network functions} *)
 
   module NN : sig
     val dropout : ?rate:float -> t -> t
@@ -356,7 +356,7 @@ module type Sig = sig
      stuff all the time. Some operations just interface to those already defined in the
      Maths module. *)
 
-  (** {6 Supported Mat functions} *)
+  (** {5 Supported Mat functions} *)
 
   module Mat : sig
     val empty : int -> int -> t
@@ -410,7 +410,7 @@ module type Sig = sig
     val print : t -> unit
   end
 
-  (** {6 Supported Arr functions} *)
+  (** {5 Supported Arr functions} *)
 
   module Arr : sig
     val empty : int array -> t

src/base/compute/owl_computation_graph_sig.ml

@@ -9,12 +9,12 @@ module type Sig = sig
   open Optimiser.Operator.Symbol.Shape.Type
   open Optimiser.Operator.Symbol.Shape.Type.Device
 
-  (** {6 Type definition} *)
+  (** {5 Type definition} *)
 
   type graph
   (** TODO *)
 
-  (** {6 Core functions} *)
+  (** {5 Core functions} *)
 
   val shape_or_value : t -> string
   (** TODO *)

src/base/compute/owl_computation_operator_sig.ml

@@ -12,7 +12,7 @@ module type Sig = sig
 
   open Symbol.Shape.Type
 
-  (** {6 Vectorised functions} *)
+  (** {5 Vectorised functions} *)
 
   val noop : arr -> arr
   (** TODO *)
@@ -568,7 +568,7 @@ module type Sig = sig
   val to_arrays : arr -> elt array array
   (** TODO *)
 
-  (** {6 Scalar functions} *)
+  (** {5 Scalar functions} *)
 
   module Scalar : sig
     val add : elt -> elt -> elt

src/base/compute/owl_computation_optimiser_sig.ml

@@ -10,7 +10,7 @@ module type Sig = sig
 
   open Operator.Symbol.Shape.Type
 
-  (** {6 Core functions} *)
+  (** {5 Core functions} *)
 
   val estimate_complexity : 'a Owl_graph.node array -> int * int
   (** TODO *)

src/base/compute/owl_computation_shape_sig.ml

@@ -10,7 +10,7 @@ module type Sig = sig
 
   open Type
 
-  (** {6 Core functions} *)
+  (** {5 Core functions} *)
 
   val infer_shape : op -> attr Owl_graph.node array -> int array option array
   (** TODO *)

src/base/compute/owl_computation_symbol_sig.ml

@@ -12,7 +12,7 @@ module type Sig = sig
   open Type
   open Device
 
-  (** {6 Core functions} *)
+  (** {5 Core functions} *)
 
   val op_to_str : op -> string
   (** TODO *)

src/base/compute/owl_computation_type_sig.ml

@@ -12,7 +12,7 @@ module type Sig = sig
 
   open Device
 
-  (** {6 Type definition} *)
+  (** {5 Type definition} *)
 
   type state =
     | Valid

src/base/core/owl_const.mli

@@ -21,7 +21,7 @@
   http://www.npl.co.uk/upload/pdf/units-of-measurement-poster.pdf
 *)
 
-(** {6 Maths constants} *)
+(** {5 Maths constants} *)
 
 val e : float
 (** e = 2.718281828459045235360287471352662498 *)
@@ -74,7 +74,7 @@ val pi_4 : float
 val eps : float
 (** eps = 1e-15 *)
 
-(** {6 Constants depending on Bigarray kind} *)
+(** {5 Constants depending on Bigarray kind} *)
 
 val zero : ('a, 'b) Bigarray.kind -> 'a
 (** ``zero kind`` returns value zero of the given number type ``kind``. *)
@@ -103,7 +103,7 @@ val min_float64 : float
 val max_float64 : float
 (** Maximum value of double precision float number. *)
 
-(** {6 Unit prefixes} *)
+(** {5 Unit prefixes} *)
 
 module Prefix : sig
   val fine_structure : float
@@ -173,7 +173,7 @@ module Prefix : sig
   (** yocto = 1e-24 *)
 end
 
-(** {6 SI: International System of Units} *)
+(** {5 SI: International System of Units} *)
 
 module SI : sig
   val speed_of_light : float
@@ -480,7 +480,7 @@ module SI : sig
   (** gauss = 1e-4 *)
 end
 
-(** {6 MKS: MKS system of units} *)
+(** {5 MKS: MKS system of units} *)
 
 module MKS : sig
   val speed_of_light : float
@@ -787,7 +787,7 @@ module MKS : sig
   (** gauss = 1e-4 *)
 end
 
-(** {6 CGS: Centimetre–gram–second system of units} *)
+(** {5 CGS: Centimetre–gram–second system of units} *)
 
 module CGS : sig
   val speed_of_light : float
@@ -1064,7 +1064,7 @@ module CGS : sig
   (** thomson_cross_section = 6.65245893699e-25 *)
 end
 
-(** {6 CGSM: Unit Systems in Electromagnetism} *)
+(** {5 CGSM: Unit Systems in Electromagnetism} *)
 
 module CGSM : sig
   val speed_of_light : float

src/base/core/owl_exception.mli

@@ -3,7 +3,7 @@
  * Copyright (c) 2016-2020 Liang Wang <[email protected]>
  *)
 
-(** {6 Core function} *)
+(** {5 Core function} *)
 
 val check : bool -> exn -> unit
 (**
@@ -41,7 +41,7 @@ val pp_exception : Format.formatter -> exn -> unit
   [@@ocaml.toplevel_printer]
 (** ``pp_exception`` is the pretty printer for Owl exceptions. *)
 
-(** {6 Exception definition} *)
+(** {5 Exception definition} *)
 
 exception CONV_INVALID_ARGUMENT
 (** Input arguments of convolution operations are invalid. *)

src/base/core/owl_graph.mli

@@ -5,7 +5,7 @@
 
 (** Graph module supports basic operations on DAG. *)
 
-(** {6 Type definition} *)
+(** {5 Type definition} *)
 
 type order =
   | BFS
@@ -22,7 +22,7 @@ type dir =
 type 'a node
 (** type definition of a node *)
 
-(** {6 Obtaining properties} *)
+(** {5 Obtaining properties} *)
 
 val id : 'a node -> int
 (** ``id x`` returns the id of node ``x``. *)
@@ -69,7 +69,7 @@ val num_descendant : 'a node array -> int
 val length : 'a node array -> int
 (** ``length x`` returns the total number of ancestors and descendants of ``x``. *)
 
-(** {6 Manipulation functions} *)
+(** {5 Manipulation functions} *)
 
 val node
   :  ?id:int
@@ -148,7 +148,7 @@ fields of the nodes in the new graph share the same memory with those in the
 original graph.
  *)
 
-(** {6 Iterators} *)
+(** {5 Iterators} *)
 
 val iter_ancestors
   :  ?order:order
@@ -190,7 +190,7 @@ val fold_in_edges : ('b -> 'a node -> 'a node -> 'b) -> 'b -> 'a node array -> '
 val fold_out_edges : ('b -> 'a node -> 'a node -> 'b) -> 'b -> 'a node array -> 'b
 (** Fold all the out-edges of a given node. *)
 
-(** {6 Helper functions} *)
+(** {5 Helper functions} *)
 
 val topo_sort : 'a node array -> 'a node array
 (**

src/base/core/owl_lazy.mli

@@ -12,7 +12,7 @@ open Owl_graph
  *)
 
 module Make (A : Ndarray_Mutable) : sig
-  (** {6 Type definition} *)
+  (** {5 Type definition} *)
 
   type arr
   (** TODO *)
@@ -29,7 +29,7 @@ module Make (A : Ndarray_Mutable) : sig
   type graph
   (** TODO *)
 
-  (** {6 Type conversion functions} *)
+  (** {5 Type conversion functions} *)
 
   val arr_to_value : A.arr -> value
   (** TODO *)
@@ -76,15 +76,15 @@ module Make (A : Ndarray_Mutable) : sig
   val elt_to_float : elt -> float
   (** TODO *)
 
-  (** {6 Utility functions} *)
+  (** {5 Utility functions} *)
 
   val graph_to_dot : graph -> string
   (** TODO *)
 
   val graph_to_trace : graph -> string
   (** TODO *)
 
-  (** {6 Create variables} *)
+  (** {5 Create variables} *)
 
   val var_arr : ?shape:int array -> string -> arr
   (** TODO *)
@@ -107,7 +107,7 @@ module Make (A : Ndarray_Mutable) : sig
   val unsafe_assign_arr : arr -> A.arr -> unit
   (** TODO *)
 
-  (** {6 Maths functions} *)
+  (** {5 Maths functions} *)
 
   val noop : arr -> arr
   (** TODO *)
@@ -541,7 +541,7 @@ module Make (A : Ndarray_Mutable) : sig
   val of_arrays : elt array array -> arr
   (** TODO *)
 
-  (** {6 Evaluation functions} *)
+  (** {5 Evaluation functions} *)
 
   val make_graph : input:attr node array -> output:attr node array -> string -> graph
   (** TODO *)

src/base/core/owl_operator.mli

@@ -5,7 +5,7 @@
 
 open Owl_types_operator
 
-(** {6 Basic operators} *)
+(** {5 Basic operators} *)
 
 module Make_Basic (M : BasicSig) : sig
   val ( + ) : ('a, 'b) M.t -> ('a, 'b) M.t -> ('a, 'b) M.t
@@ -66,7 +66,7 @@ module Make_Basic (M : BasicSig) : sig
   (** Operator of ``less_equal`` *)
 end
 
-(** {6 Extended operators} *)
+(** {5 Extended operators} *)
 
 module Make_Extend (M : ExtendSig) : sig
   val ( =$ ) : ('a, 'b) M.t -> 'a -> bool
@@ -202,7 +202,7 @@ module Make_Extend (M : ExtendSig) : sig
   (** Operator of ``set_slice`` *)
 end
 
-(** {6 Matrix-specific operators} *)
+(** {5 Matrix-specific operators} *)
 
 module Make_Matrix (M : MatrixSig) : sig
   val ( *@ ) : ('a, 'b) M.t -> ('a, 'b) M.t -> ('a, 'b) M.t
@@ -215,7 +215,7 @@ module Make_Matrix (M : MatrixSig) : sig
   (** Operator of ``set`` *)
 end
 
-(** {6 Ndarray-specific operators} *)
+(** {5 Ndarray-specific operators} *)
 
 module Make_Ndarray (M : NdarraySig) : sig
   val ( .%{;..} ) : ('a, 'b) M.t -> int array -> 'a
@@ -225,7 +225,7 @@ module Make_Ndarray (M : NdarraySig) : sig
   (** Operator of ``set`` *)
 end
 
-(** {6 Linalg-specific operators} *)
+(** {5 Linalg-specific operators} *)
 
 module Make_Linalg (M : LinalgSig) : sig
   val ( **@ ) : ('a, 'b) M.t -> float -> ('a, 'b) M.t

src/base/dense/owl_base_dense_matrix_generic.mli

@@ -20,7 +20,7 @@ aforementioned conventions.
 
 open Bigarray
 
-(** {6 Type definition} *)
+(** {5 Type definition} *)
 
 type ('a, 'b) t = ('a, 'b, c_layout) Genarray.t
 (**