diff options
| author | Lukas Larsson <lukas@erlang.org> | 2020-02-24 10:35:44 +0100 |
|---|---|---|
| committer | Lukas Larsson <lukas@erlang.org> | 2020-02-24 10:35:44 +0100 |
| commit | 1befa3c8ea9c1ddab1da4c5f94b5c64dc240dacd (patch) | |
| tree | bd54b669f72687d64e31ae7ec4082360a6de27f5 /HOWTO | |
| parent | 1e39e289826e4c70ae6de9bfb990d28a92a85580 (diff) | |
| download | erlang-1befa3c8ea9c1ddab1da4c5f94b5c64dc240dacd.tar.gz | |
otp: Update doc build instructions with DOC_TARGETS
Diffstat (limited to 'HOWTO')
| -rw-r--r-- | HOWTO/INSTALL.md | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/HOWTO/INSTALL.md b/HOWTO/INSTALL.md index 0c7de9d4e6..3af9091468 100644 --- a/HOWTO/INSTALL.md +++ b/HOWTO/INSTALL.md @@ -217,6 +217,12 @@ Build the documentation. $ make docs +It is possible to limit which types of documentation is build by passing the `DOC_TARGETS` +environment variable to `make docs`. The currently available types are: `html`, `pdf`, `man` and +`chunks`. Example: + + $ make docs DOC_TARGETS=chunks + #### Build Issues #### We have sometimes experienced problems with Oracle's `java` running out of @@ -247,6 +253,8 @@ or using the `release_docs` target. $ make release_docs RELEASE_ROOT=<release dir> +It is possible to limit which types of documentation is released using the same `DOC_TARGETS` +environment variable as when building documentation. ### Accessing the Documentation ### @@ -261,6 +269,8 @@ After installation you can access the documentation by * Browsing the html pages by loading the page `/usr/local/lib/erlang/doc/erlang/index.html` or `<BaseDir>/lib/erlang/doc/erlang/index.html` if the prefix option has been used. +* Read the embedded documentation by using the built-in shell functions `h/1,2,3` or + `ht/1,2,3`. ### How to Install the Pre-formatted Documentation ### |