Skip to content

(docs) Add dune ocaml doc command to generating-documentation tutorial #3391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

(docs) Add dune ocaml doc command to generating-documentation tutorial #3391

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions data/tutorials/platform/2_08_odoc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,14 @@
$ explorer _build\default\_doc\_html\index.html
```

Alternatively, you can use the `dune ocaml doc` command, which builds the documentation and automatically opens it in your web browser:

```shell
$ dune ocaml doc

Check failure on line 29 in data/tutorials/platform/2_08_odoc.md

View workflow job for this annotation

GitHub Actions / lint

Dollar signs used before commands without showing output 

data/tutorials/platform/2_08_odoc.md:29:1 MD014/commands-show-output Dollar signs used before commands without showing output [Context: "$ dune ocaml doc"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md014.md
```

This is a convenient shortcut that combines the build and open steps into a single command.

## Generating `.mld` Documentation Pages

In addition to documenting the publicly-visible API of your project,
Expand All @@ -35,7 +43,7 @@
the `dune` file in the same directory as your `.mld` files needs to
include this stanza:

```

Check failure on line 46 in data/tutorials/platform/2_08_odoc.md

View workflow job for this annotation

GitHub Actions / lint

Fenced code blocks should have a language specified 

data/tutorials/platform/2_08_odoc.md:46 MD040/fenced-code-language Fenced code blocks should have a language specified [Context: "```"] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md040.md
(documentation
(package name-of-your-package))
```
Expand Down
Loading