diff options
| author | Sam Ruby <rubys@intertwingly.net> | 2018-07-03 12:46:56 -0400 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-07-09 22:57:33 +0300 |
| commit | 0c743b5f77a53f278d6d6554e69d2d55ef945f66 (patch) | |
| tree | 18e34392c8f668d5c3777b259785c86606ede358 /Makefile | |
| parent | 1529ef4dc5e4cf99ea964bc1cc47cd62cca17540 (diff) | |
| download | android-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.tar.gz android-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.tar.bz2 android-node-v8-0c743b5f77a53f278d6d6554e69d2d55ef945f66.zip | |
tools: build all.json by combining generated JSON
Notes:
1) Removed a number of root properties that did not seem relevant:
source, desc, and introduced_in. There no longer is a source, and
the other two are from the first include and do not reflect the
entire API.
2) As with https://github.com/nodejs/node/issues/20100, the current
"desc" properties sometimes contained in-page links, other times
referenced another page, and often did not match the links in the
original HTML or JSON file. I chose to standardize on external links
as "desc" values are isolated snippets as opposed to all.html which
can be viewed as a standalone and self contained document.
3) Eliminated preprocessing for @include entirely, including the test
case for this function.
4) _toc.md was renamed to index.md.
5) index comments no longer appear in embedded TOCs (left hand side
column in the generated documentation.
PR-URL: https://github.com/nodejs/node/pull/21637
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'Makefile')
| -rw-r--r-- | Makefile | 8 |
1 files changed, 5 insertions, 3 deletions
@@ -615,7 +615,7 @@ doc-only: $(apidoc_dirs) $(apiassets) ## Builds the docs with the local or the if [ ! -d doc/api/assets ]; then \ $(MAKE) tools/doc/node_modules/js-yaml/package.json; \ fi; - @$(MAKE) $(apidocs_html) $(apidocs_json) + @$(MAKE) out/doc/api/all.html out/doc/api/all.json .PHONY: doc doc: $(NODE_EXE) doc-only @@ -665,10 +665,12 @@ out/doc/api/%.json: doc/api/%.md tools/doc/generate.js tools/doc/json.js out/doc/api/%.html: doc/api/%.md tools/doc/generate.js tools/doc/html.js $(call available-node, $(gen-html)) -out/doc/api/all.html: $(filter-out out/doc/api/all.html, $(apidocs_html)) \ - tools/doc/allhtml.js +out/doc/api/all.html: $(apidocs_html) tools/doc/allhtml.js $(call available-node, tools/doc/allhtml.js) +out/doc/api/all.json: $(apidocs_json) tools/doc/alljson.js + $(call available-node, tools/doc/alljson.js) + .PHONY: docopen docopen: $(apidocs_html) @$(PYTHON) -mwebbrowser file://$(PWD)/out/doc/api/all.html |