From 86f918df71fe3e04fed4945f18d95dd5e073b4fe Mon Sep 17 00:00:00 2001 From: Rudi Grinberg Date: Tue, 20 Mar 2018 08:22:19 +0800 Subject: [PATCH] Clarify about index.mld This isn't odoc specific --- doc/documentation.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/documentation.rst b/doc/documentation.rst index e69bbb73..8b0539d9 100644 --- a/doc/documentation.rst +++ b/doc/documentation.rst @@ -61,8 +61,10 @@ Where ```` are: ``.mld`` files in the stanza's directory. The ``index.mld`` file (specified as ``index`` in ``mld_files``) is treated -specially by odoc. This will be the file used to generate the entry page for the -package. +specially by jbulder. This will be the file used to generate the entry page for +the package. This is the page that will be linked from the main package listing. +If you omit writing an ``index.mld``, jbuilder will generate one with the entry +modules for your package. But this generated will not be installed. All mld files attached to a package will be included in the generated ``.install`` file for that package, and hence will be installed by opam.