diff options
author | Derek Lewis <DerekNonGeneric@inf.is> | 2020-08-30 15:52:17 +0300 |
---|---|---|
committer | Derek Lewis <DerekNonGeneric@inf.is> | 2020-09-06 23:25:49 +0300 |
commit | ff0aad0f747470d33d85fba4deb795a79c55c1a6 (patch) | |
tree | a0bdbc63344c8bff3511d0bf6748619f38acbdc9 /Makefile | |
parent | 8ae2f479549be295250867d20cfe17ceb68f72c4 (diff) |
doc: spruce up user journey to local docs browsing
This patch improves the means by which the docs are viewed locally.
* Remove extraneous code in the `docserve` Makefile target
* Document the `docserve` task for all to know
* Bring all code snippets in this section up to speed
* Clarify the purpose of each documentation browsing method
Fixes: https://github.com/nodejs/node/issues/34977
PR-URL: https://github.com/nodejs/node/pull/34986
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Diffstat (limited to 'Makefile')
-rw-r--r-- | Makefile | 5 |
1 files changed, 2 insertions, 3 deletions
@@ -775,9 +775,8 @@ docopen: $(apidocs_html) @$(PYTHON) -mwebbrowser file://$(PWD)/out/doc/api/all.html .PHONY: docserve -docserve: $(apidocs_html) - @$(PYTHON) -mwebbrowser http://localhost:8000/all.html - @$(PYTHON) -m http.server -d $(PWD)/out/doc/api +docserve: $(apidocs_html) $(apiassets) + @$(PYTHON) -m http.server 8000 --bind 127.0.0.1 --directory out/doc/api .PHONY: docclean docclean: |