1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
Description: build doc using marked and js-yaml
While waiting for unified/remarked/rehyped modules to be available in debian
Author: Jérémy Lal <kapouer@melix.org>
Forwarded: not-needed
Reviewed-By: Xavier Guimard <yadd@debian.org>
Last-Update: 2021-03-03
--- a/Makefile
+++ b/Makefile
@@ -668,11 +668,6 @@
.PHONY: test-doc
test-doc: doc-only lint-md ## Build, lint, and verify the docs.
- @if [ "$(shell $(node_use_openssl))" != "true" ]; then \
- echo "Skipping test-doc (no crypto)"; \
- else \
- $(PYTHON) tools/test.py $(PARALLEL_ARGS) doctool; \
- fi
.PHONY: test-doc-ci
test-doc-ci: doc-only ## Build, lint, and verify the docs (CI).
@@ -802,12 +797,12 @@
fi
.PHONY: doc-only
-doc-only: tools/doc/node_modules \
+doc-only: \
$(apidoc_dirs) $(apiassets) ## Build the docs with the local or the global Node.js binary.
@if [ "$(shell $(node_use_openssl))" != "true" ]; then \
echo "Skipping doc-only (no crypto)"; \
else \
- $(MAKE) out/doc/api/all.html out/doc/api/all.json out/doc/api/stability; \
+ $(MAKE) out/doc/api/all.html out/doc/api/all.json; \
fi
.PHONY: doc
@@ -821,7 +816,9 @@
# Just copy everything under doc/api over.
out/doc/api: doc/api
mkdir -p $@
- cp -r doc/api out/doc
+ cp -r doc/api out/doc/
+ rm -f out/doc/api/*.html
+ rm -f out/doc/api/*.json
# If it's a source tarball, assets are already in doc/api/assets
out/doc/api/assets:
@@ -837,50 +834,50 @@
LINK_DATA = out/doc/apilinks.json
VERSIONS_DATA = out/previous-doc-versions.json
-gen-api = tools/doc/generate.mjs --node-version=$(FULLVERSION) \
+gen-api = debian/doc-generator/generate.mjs --node-version=$(FULLVERSION) \
--apilinks=$(LINK_DATA) $< --output-directory=out/doc/api \
--versions-file=$(VERSIONS_DATA)
-gen-apilink = tools/doc/apilinks.mjs $(LINK_DATA) $(wildcard lib/*.js)
+gen-apilink = debian/doc-generator/apilinks.mjs $(LINK_DATA) $(wildcard lib/*.js)
-$(LINK_DATA): $(wildcard lib/*.js) tools/doc/apilinks.mjs | out/doc
+$(LINK_DATA): $(wildcard lib/*.js) debian/doc-generator/apilinks.mjs | out/doc
$(call available-node, $(gen-apilink))
# Regenerate previous versions data if the current version changes
-$(VERSIONS_DATA): CHANGELOG.md src/node_version.h tools/doc/versions.mjs
- $(call available-node, tools/doc/versions.mjs $@)
+$(VERSIONS_DATA): CHANGELOG.md src/node_version.h debian/doc-generator/versions.mjs
+ $(call available-node, debian/doc-generator/versions.mjs $@)
node_use_icu = $(call available-node,"-p" "typeof Intl === 'object'")
-out/doc/api/%.json out/doc/api/%.html: doc/api/%.md tools/doc/generate.mjs \
- tools/doc/markdown.mjs tools/doc/html.mjs tools/doc/json.mjs \
- tools/doc/apilinks.mjs $(VERSIONS_DATA) | $(LINK_DATA) out/doc/api
+out/doc/api/%.json out/doc/api/%.html: doc/api/%.md debian/doc-generator/generate.mjs \
+ debian/doc-generator/markdown.mjs debian/doc-generator/html.mjs debian/doc-generator/json.mjs \
+ debian/doc-generator/apilinks.mjs $(VERSIONS_DATA) | $(LINK_DATA) out/doc/api
@if [ "$(shell $(node_use_icu))" != "true" ]; then \
echo "Skipping documentation generation (no ICU)"; \
else \
$(call available-node, $(gen-api)) \
fi
-out/doc/api/all.html: $(apidocs_html) tools/doc/allhtml.mjs \
- tools/doc/apilinks.mjs | out/doc/api
+out/doc/api/all.html: $(apidocs_html) debian/doc-generator/allhtml.mjs \
+ debian/doc-generator/apilinks.mjs | out/doc/api
@if [ "$(shell $(node_use_icu))" != "true" ]; then \
echo "Skipping HTML single-page doc generation (no ICU)"; \
else \
- $(call available-node, tools/doc/allhtml.mjs) \
+ $(call available-node, debian/doc-generator/allhtml.mjs) \
fi
-out/doc/api/all.json: $(apidocs_json) tools/doc/alljson.mjs | out/doc/api
+out/doc/api/all.json: $(apidocs_json) debian/doc-generator/alljson.mjs | out/doc/api
@if [ "$(shell $(node_use_icu))" != "true" ]; then \
echo "Skipping JSON single-file generation (no ICU)"; \
else \
- $(call available-node, tools/doc/alljson.mjs) \
+ $(call available-node, debian/doc-generator/alljson.mjs) \
fi
.PHONY: out/doc/api/stability
-out/doc/api/stability: out/doc/api/all.json tools/doc/stability.mjs | out/doc/api
+out/doc/api/stability: out/doc/api/all.json debian/doc-generator/stability.mjs | out/doc/api
@if [ "$(shell $(node_use_icu))" != "true" ]; then \
echo "Skipping stability indicator generation (no ICU)"; \
else \
- $(call available-node, tools/doc/stability.mjs) \
+ $(call available-node, debian/doc-generator/stability.mjs) \
fi
.PHONY: docopen
|
