From acae2dcfce2f29efb56fec58b876e206329cd6ef Mon Sep 17 00:00:00 2001 From: Théo Zimmermann Date: Tue, 6 Apr 2021 11:42:01 +0200 Subject: Add odoc warnings for empty packages. From an OCaml library point of view. --- doc/dune | 3 +++ doc/index.mld | 3 +++ dune | 3 +++ ide/coqide/dune | 3 +++ ide/coqide/index.mld | 3 +++ index.mld | 5 +++++ theories/dune | 3 +++ theories/index.mld | 3 +++ 8 files changed, 26 insertions(+) create mode 100644 doc/index.mld create mode 100644 ide/coqide/index.mld create mode 100644 index.mld create mode 100644 theories/index.mld diff --git a/doc/dune b/doc/dune index 97bd437097..dd3b37eacb 100644 --- a/doc/dune +++ b/doc/dune @@ -63,3 +63,6 @@ (files (refman-html as html/refman) (refman-pdf as pdf/refman)) (section doc) (package coq-doc)) + +(documentation + (package coq-doc)) diff --git a/doc/index.mld b/doc/index.mld new file mode 100644 index 0000000000..3a1979bc62 --- /dev/null +++ b/doc/index.mld @@ -0,0 +1,3 @@ +{0 coq-doc } + +The coq-doc package only contains user documentation on the Coq proof assistant and no OCaml library. diff --git a/dune b/dune index 6547f5c859..31c6b41284 100644 --- a/dune +++ b/dune @@ -35,3 +35,6 @@ (deps test-suite/summary.log)) ; (dirs (:standard _build_ci)) + +(documentation + (package coq)) diff --git a/ide/coqide/dune b/ide/coqide/dune index 4bb4672cd4..d2642f77bf 100644 --- a/ide/coqide/dune +++ b/ide/coqide/dune @@ -51,6 +51,9 @@ (modes exe byte) (libraries coqide_gui)) +(documentation + (package coqide)) + ; Input-method bindings (executable (name default_bindings_src) diff --git a/ide/coqide/index.mld b/ide/coqide/index.mld new file mode 100644 index 0000000000..8852a2a7eb --- /dev/null +++ b/ide/coqide/index.mld @@ -0,0 +1,3 @@ +{0 coqide } + +The coqide package only contains the CoqIDE executable and no OCaml library. diff --git a/index.mld b/index.mld new file mode 100644 index 0000000000..068a5f0cb5 --- /dev/null +++ b/index.mld @@ -0,0 +1,5 @@ +{0 coq } + +The coq package is a virtual package gathering the coq-core and coq-stdlib packages. + +For the documentation of the OCaml API of Coq, see the coq-core package. diff --git a/theories/dune b/theories/dune index 1cd3d8c119..a5812093d6 100644 --- a/theories/dune +++ b/theories/dune @@ -34,3 +34,6 @@ coq-core.plugins.derive)) (include_subdirs qualified) + +(documentation + (package coq-stdlib)) diff --git a/theories/index.mld b/theories/index.mld new file mode 100644 index 0000000000..360864342b --- /dev/null +++ b/theories/index.mld @@ -0,0 +1,3 @@ +{0 coq-stdlib } + +The coq-stdlib package only contains Coq theory files for the standard library and no OCaml libraries. -- cgit v1.2.3 From 1bc23f9672be0e83fd0f3dfc6f94e3c8ee99eb8c Mon Sep 17 00:00:00 2001 From: Théo Zimmermann Date: Tue, 6 Apr 2021 19:17:30 +0200 Subject: Add a relative link to coq-core. --- index.mld | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/index.mld b/index.mld index 068a5f0cb5..706688656e 100644 --- a/index.mld +++ b/index.mld @@ -2,4 +2,4 @@ The coq package is a virtual package gathering the coq-core and coq-stdlib packages. -For the documentation of the OCaml API of Coq, see the coq-core package. +For the documentation of the OCaml API of Coq, see the {{: ../coq-core/index.html } coq-core } package. -- cgit v1.2.3