Skip to content

doc: documented make docopen #19321

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

Closed
AyushG3112 wants to merge 7 commits into from
+9 −0
Closed

doc: documented make docopen #19321

Changes from 1 commit
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: Added python SimpleHTTPServer as a method reading docs in browser 
Documented an easier way for users to browse documentation without
setting up a whole web environment. It make the process of reading the
latest documentation, and comparing it with the documentation of
older versions on the Node.JS website a lot easier.
  • Loading branch information
@AyushG3112
AyushG3112 committed Mar 26, 2018
commit 0770c1f6e8d3a0e137dc3d3a5d8d11ffd7e8c74f
9 changes: 5 additions & 4 deletions BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -206,14 +206,15 @@ To read the documentation:
$ man doc/node.1
```

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

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

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

To test if Node.js was built correctly:

Expand Down