Skip to content

Commit

Permalink
doc: document make doconly
Browse files Browse the repository at this point in the history
Documented `make doconly` as a way to read documentation in the browser.
  • Loading branch information
AyushG3112 committed Mar 26, 2018
1 parent 0770c1f commit abd7fc0
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions BUILDING.md
Expand Up @@ -206,15 +206,14 @@ To read the documentation:
$ man doc/node.1
```

If you prefer to read the documentation in the browser and have `python`
installed, you can run:
If you prefer to read the documentation in the browser,
run the following once `make doc` is done:

```console
$ cd out/doc/api/
$ python -m SimpleHTTPServer
$ make doconly
```

and navigate to `http://localhost:8000` in your browser.
This will open up a browser tab/window with the documentation.

To test if Node.js was built correctly:

Expand Down

0 comments on commit abd7fc0

Please sign in to comment.