File tree Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Expand file tree Collapse file tree 1 file changed +3
-3
lines changed Original file line number Diff line number Diff line change @@ -175,17 +175,17 @@ installed and might be used by a different driver.
175
175
In order for drivers to build consistent documentation for a package, the
176
176
following convention should be followed.
177
177
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
179
179
[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
181
181
page, for example it can be named after the package. In what follows, we
182
182
refer to this page as the [pkg] page.
183
183
- If there is an installed [index.mld] file, the driver has to use it as
184
184
content for the [pkg] page.
185
185
- If there is no installed [index.mld] page, the driver has to generate some
186
186
content for the [pkg] page.
187
187
188
- This convention is followed by the
188
+ This convention (excluding assets) is followed by the
189
189
{{:https://github.com/ocaml-doc/voodoo}driver for ocaml.org},
190
190
by the driver {{:https://erratique.ch/software/odig/doc/packaging.html}Odig}
191
191
and by the build system {{:https://github.com/ocaml/dune}Dune}.
You can’t perform that action at this time.
0 commit comments