@@ -177,18 +177,23 @@ following convention should be followed.
177
177
178
178
- [.mld] pages are installed in a package's [share] directory, under the
179
179
[odoc-pages] sub-directory.
180
- - [index.mld] is the parent of every other pages. The driver can freely rename
181
- this page, for example, it can be named after the package.
182
- - Other pages are children of the [index.mld] page.
183
-
184
- If no [index.mld] is installed, it's the driver's responsibility to generate
185
- it.
180
+ - A page is the parent of every installed pages. The driver can freely name this
181
+ page, for example it can be named after the package. In what follows, we
182
+ refer to this page as the [pkg] page.
183
+ - If there is an installed [index.mld] file:
184
+ + The driver has to use it as content for the [pkg] page.
185
+ + The can decide to also include a [index] page as child of the [pkg] page.
186
+ - If it does not, then some references to the [index] page might be
187
+ unresolved.
188
+ - If it does, it will create a warning.
189
+ - If there is no installed [index.mld] page, the driver has to generate some
190
+ content for the [pkg] page.
186
191
187
192
When the rendering of source code is enabled, the source tree will be named
188
- [source] and will be a child of [index.mld] . As a consequence, no page can be
189
- named [source.mld].
193
+ [source] and will be a child of the [pkg] page . As a consequence, no installed
194
+ page can be named [source.mld].
190
195
191
- This convention is followed by the drivers
192
- {{:https://erratique.ch/software/odig/ doc/packaging.html}Odig}
193
- and {{:https://github.com/ocaml- doc/voodoo}ocaml.org }
196
+ This convention is followed by the
197
+ {{:https://github.com/ocaml- doc/voodoo}driver for ocaml.org},
198
+ by the driver {{:https://erratique.ch/software/odig/ doc/packaging.html}Odig }
194
199
and by the build system {{:https://github.com/ocaml/dune}Dune}.
0 commit comments