dune icon indicating copy to clipboard operation
dune copied to clipboard

doc: have the 'OCaml flags' documentation point to complete examples

Open gasche opened this issue 2 years ago • 2 comments

I had forgotten how to disable a warning with Dune, unfortunately the "OCaml flags" documentation does not actually contain any reusable code snippet doing this. In fact, the information is in the doc, hidden in the "Quickstart" and the "FAQ" pages.

This commit adds references from the "OCaml flags" reference section to those usage examples.

gasche avatar Dec 25 '23 14:12 gasche

(I haven't tried generating the documentation locally to check that the reference syntax works. Hopefully someone who knows about this stuff can check from the CI results.)

gasche avatar Dec 25 '23 14:12 gasche

There is a docs/readthedocs.org:dune job in the CI that you can use to view the documentation.

Edit: For some reason, the readthedocs is failing, even if I manually go to the job.

Alizter avatar Dec 25 '23 15:12 Alizter