Merge pull request #426 from FardaleM/cleanup

Cleanup

.github/workflows/gh-pages.yml

@@ -19,15 +19,17 @@ jobs:
           dune-cache: false
 
       - name: Deps
-        run: opam install -d . --deps-only
+        run: |
+          opam install -d . --deps-only;
+          opam install odig
 
       - name: Build
-        run: opam exec -- dune build @doc
+        run: opam exec -- odig odoc --cache-dir=_doc/ containers containers-data containers-thread
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./_build/default/_doc/_html/
+          publish_dir: ./_doc/html/
           destination_dir: dev
           enable_jekyll: true

src/core/CCArray.mli

@@ -17,22 +17,19 @@ type 'a printer = Format.formatter -> 'a -> unit
 [@@@ifge 4.8]
 
 include module type of Array
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}
-    @inline *)
+(** @inline *)
 
 [@@@elifge 4.6]
 
 include module type of Array
-(** @inline
-    {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
+(** @inline *)
 
 type 'a t = 'a array
 
 [@@@else_]
 
 include module type of Array
-(** @inline
-    {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
+(** @inline *)
 
 module Floatarray : sig
   type t = float array

src/core/CCArrayLabels.mli

@@ -17,22 +17,19 @@ type 'a printer = Format.formatter -> 'a -> unit
 [@@@ifge 4.8]
 
 include module type of ArrayLabels with module Floatarray = Array.Floatarray
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}
-    @inline *)
+(** @inline *)
 
 [@@@elifge 4.6]
 
 include module type of ArrayLabels with module Floatarray = Array.Floatarray
-(** @inline
-    {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
+(** @inline *)
 
 type 'a t = 'a array
 
 [@@@else_]
 
 include module type of ArrayLabels
-(** @inline
-    {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Array.html} Documentation for the standard Array module}*)
+(** @inline *)
 
 module Floatarray = CCArray.Floatarray
 

src/core/CCChar.mli

@@ -4,10 +4,10 @@
 
     @since 0.14 *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Char.html} Documentation for the standard Char module}*)
 include module type of struct
   include Char
 end
+(** @inline *)
 
 val compare : t -> t -> int
 (** The comparison function for characters, with the same specification as

src/core/CCFormat.mli

@@ -10,10 +10,10 @@ type 'a iter = ('a -> unit) -> unit
    see https://discuss.ocaml.org/t/extend-existing-module/1389/4
 *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Format.html} Documentation for the standard Format module}*)
 include module type of struct
   include Format
 end
+(** @inline *)
 
 type t = Format.formatter
 type -'a printer = t -> 'a -> unit

src/core/CCInt.mli

@@ -5,8 +5,7 @@
 [@@@ifge 4.08]
 
 include module type of Int
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int.html} Documentation for the standard Int module}
-    @inline *)
+(** @inline *)
 
 [@@@endif]
 

src/core/CCInt32.mli

@@ -13,10 +13,10 @@
 
     @since 2.1 *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int32.html} Documentation for the standard Int32 module}*)
 include module type of struct
   include Int32
 end
+(** @inline *)
 
 val min : t -> t -> t
 (** [min x y] returns the minimum of the two integers [x] and [y].

src/core/CCInt64.mli

@@ -13,10 +13,10 @@
 
     @since 0.13 *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Int64.html} Documentation for the standard Int64 module}*)
 include module type of struct
   include Int64
 end
+(** @inline *)
 
 val min : t -> t -> t
 (** [min x y] returns the minimum of the two integers [x] and [y].

src/core/CCList.mli

@@ -13,16 +13,14 @@ type 'a random_gen = Random.State.t -> 'a
 [@@@ifge 4.8]
 
 include module type of List with type 'a t := 'a list
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/List.html} Documentation for the standard List module}
-    @inline *)
+(** @inline *)
 
 type +'a t = 'a list
 
 [@@@else_]
 
 include module type of List
-(** @inline
-    {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/List.html} Documentation for the standard List module}*)
+(** @inline *)
 
 type +'a t = 'a list
 

src/core/CCListLabels.mli

@@ -11,7 +11,7 @@ type 'a printer = Format.formatter -> 'a -> unit
 type 'a random_gen = Random.State.t -> 'a
 
 include module type of ListLabels
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/ListLabels.html} Documentation for the standard ListLabels module}*)
+(** @inline *)
 
 type 'a t = 'a list
 

src/core/CCNativeint.mli

@@ -14,10 +14,10 @@
 
     @since 2.1 *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Nativeint.html} Documentation for the standard Nativeint module}*)
 include module type of struct
   include Nativeint
 end
+(** @inline *)
 
 val min : t -> t -> t
 (** [min x y] returns the minimum of the two integers [x] and [y].

src/core/CCRandom.mli

@@ -2,10 +2,10 @@
 
 (** Random Generators *)
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/Random.html} Documentation for the standard Random module}*)
 include module type of struct
   include Random
 end
+(** @inline *)
 
 type state = Random.State.t
 

src/core/CCString.mli

@@ -8,10 +8,10 @@ type 'a iter = ('a -> unit) -> unit
 
 type 'a gen = unit -> 'a option
 
-(** {{: https://caml.inria.fr/pub/docs/manual-ocaml/libref/String.html} Documentation for the standard String module}*)
 include module type of struct
   include String
 end
+(** @inline *)
 
 val length : t -> int
 (** [length s] returns the length (number of characters) of the given string [s]. *)