Skip to content
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

Jump to bottom

doc: documented make docopen #19321

Closed
wants to merge 7 commits into from
Closed

doc: documented make docopen #19321

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d8e7de
doc: Added python SimpleHTTPServer as a method reading docs in browser
AyushG3112 Mar 13, 2018
ecb58d0
doc: document `make doconly`
AyushG3112 Mar 13, 2018
c355442
doc: fix doconly to docopen
AyushG3112 Mar 13, 2018
0770c1f
doc: Added python SimpleHTTPServer as a method reading docs in browser
AyushG3112 Mar 13, 2018
abd7fc0
doc: document `make doconly`
AyushG3112 Mar 13, 2018
b971a1e
doc: fix doconly to docopen
AyushG3112 Mar 13, 2018
f6a70dc
doc: address nits requested by @Trott
AyushG3112 Mar 15, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions BUILDING.md
View file
Open in desktop
Expand Up @@ -206,6 +206,15 @@ To read the documentation:
$ man doc/node.1
```

If you prefer to read the documentation in a browser,
run the following after `make doc` is finished:

```console
$ make docopen
```

This will open a browser with the documentation.

To test if Node.js was built correctly:

```console
Expand Down