Skip to content

Commit 02b4b5c

Browse files
committed
docs: add a note about the make doc command
1 parent f378088 commit 02b4b5c

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/howto-setup-exercise-development-environment.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,55 +47,69 @@ your exercises.
4747
We assume that the current directory is `$DIR`.
4848

4949
First, clone the current learn-ocaml source tree:
50+
5051
```
5152
git clone [email protected]:ocaml-sf/learn-ocaml.git && cd learn-ocaml
5253
```
5354

5455
If you do not have a GitHub account, do instead:
56+
5557
```
5658
git clone https://github.com/ocaml-sf/learn-ocaml.git && cd learn-ocaml
5759
```
5860

5961
Get an opam environment (a.k.a "switch") with the learn-ocaml dependencies
6062
ready:
63+
6164
```
6265
opam switch create . --deps-only --locked
6366
opam install opam-installer
6467
eval $(opam env)
6568
```
69+
6670
(Alternatively, use `opam install . --deps-only` to install the dependencies in
6771
your current opam switch, without creating a dedicated one.)
6872

6973

7074
Second, compile and install the platform:
75+
7176
```
7277
make && make opaminstall
7378
```
7479

7580
At this point, you should get a working `learn-ocaml` program in
7681
your path. Try:
82+
7783
```
7884
learn-ocaml --help
7985
```
86+
8087
This should open the manpage of the command-line tool to interact
8188
with the platform.
8289

90+
> **Note for developers:**
91+
> An API documentation could be partially generated with the `make doc` command.
92+
> _Currently, the only two supported modules are `Test_lib` and `Learnocaml_report`_.
93+
8394
## Step 2: Set up a work directory
8495

8596
Now, let us go back to `$DIR` and create a root for the source tree of exercises:
97+
8698
```
8799
cd $DIR && cp -fr learn-ocaml/demo-repository my-learn-ocaml-repository
88100
```
89101

90102
## Step 3: Sanity check
91103

92104
Check that your installation works:
105+
93106
```
94107
learn-ocaml build --repo my-learn-ocaml-repository
95108
learn-ocaml serve
96109
```
97110

98111
This should output several lines in your terminal ending with:
112+
99113
```
100114
Starting server on port 8080
101115
```

0 commit comments

Comments
 (0)