Skip to content

Commit 272d8e7

Browse files
committed
Assets: Update convention for installed packages
Signed-off-by: Paul-Elliot <[email protected]>
1 parent 367601a commit 272d8e7

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/parent_child_spec.mld

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -175,17 +175,17 @@ installed and might be used by a different driver.
175175
In order for drivers to build consistent documentation for a package, the
176176
following convention should be followed.
177177

178-
- [.mld] pages are installed in a package's [share] directory, under the
178+
- [.mld] pages and assets are installed in a package's [share] directory, under the
179179
[odoc-pages] sub-directory.
180-
- A page is the parent of every installed pages. The driver can freely name this
180+
- A page is the parent of every installed pages and assets. The driver can freely name this
181181
page, for example it can be named after the package. In what follows, we
182182
refer to this page as the [pkg] page.
183183
- If there is an installed [index.mld] file, the driver has to use it as
184184
content for the [pkg] page.
185185
- If there is no installed [index.mld] page, the driver has to generate some
186186
content for the [pkg] page.
187187

188-
This convention is followed by the
188+
This convention (excluding assets) is followed by the
189189
{{:https://github.com/ocaml-doc/voodoo}driver for ocaml.org},
190190
by the driver {{:https://erratique.ch/software/odig/doc/packaging.html}Odig}
191191
and by the build system {{:https://github.com/ocaml/dune}Dune}.

0 commit comments

Comments
 (0)