From 0770c1f6e8d3a0e137dc3d3a5d8d11ffd7e8c74f Mon Sep 17 00:00:00 2001 From: Ayush Gupta Date: Tue, 13 Mar 2018 19:51:54 +0530 Subject: [PATCH] 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. --- BUILDING.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/BUILDING.md b/BUILDING.md index c3967c1fa5d382..4c88b4f67eb23c 100644 --- a/BUILDING.md +++ b/BUILDING.md @@ -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: