Skip to content

Commit d78d2df

Browse files
committed
doc: add an index page for the learn-ocaml documentation
1 parent aa4300b commit d78d2df

File tree

3 files changed

+17
-1
lines changed

3 files changed

+17
-1
lines changed

learn-ocaml.opam

+1-1
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ depends: [
5858
]
5959
build: [
6060
[make "static"]
61-
["dune" "build" "-p" name "-j" jobs]
61+
["dune" "build" "-p" name "-j" jobs "@doc"]
6262
]
6363
install: [
6464
["mkdir" "-p" "%{_:share}%"]

src/dune

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
(documentation
2+
(package learn-ocaml)
3+
(mld_files index))

src/index.mld

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{0 The [learn-ocaml] online platform (engine)}
2+
3+
This contains the documentation for the exposed modules used to build binaries
4+
forming the engine for the learn-ocaml platform, and the common files.
5+
6+
{1 List of documented modules}
7+
8+
Modules documentation could be found here:
9+
10+
{ul
11+
{li {{: Test_lib/index.html} [Test_lib]}}
12+
{li {{: Learnocaml_report/index.html} [Learnocaml_report]}}
13+
}

0 commit comments

Comments
 (0)