Skip to content

tools: build doc/api/all.html by combining generated HTML #21544

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
rubys wants to merge 2 commits into from
Closed

tools: build doc/api/all.html by combining generated HTML #21544

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
51aed5d
tools: build doc/api/all.html by combining generated HTML
rubys Jun 26, 2018
5e9cf65
fix version picker links
rubys Jun 27, 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
fix version picker links 
also update Makefile to make apidocs depend on the tools
  • Loading branch information
@rubys
rubys committed Jun 27, 2018
commit 5e9cf65e3035bbde6d0017db284aa74f29b88bf8
7 changes: 4 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -629,13 +629,14 @@ gen-json = tools/doc/generate.js --format=json $< > $@
gen-html = tools/doc/generate.js --node-version=$(FULLVERSION) --format=html \
--analytics=$(DOCS_ANALYTICS) $< > $@

out/doc/api/%.json: doc/api/%.md
out/doc/api/%.json: doc/api/%.md tools/doc/generate.js
$(call available-node, $(gen-json))

out/doc/api/%.html: doc/api/%.md
out/doc/api/%.html: doc/api/%.md tools/doc/generate.js
$(call available-node, $(gen-html))

out/doc/api/all.html: $(filter-out out/doc/api/all.html, $(apidocs_html))
out/doc/api/all.html: $(filter-out out/doc/api/all.html, $(apidocs_html)) \
tools/doc/allhtml.js
$(call available-node, tools/doc/allhtml.js)

.PHONY: docopen
Expand Down
8 changes: 8 additions & 0 deletions tools/doc/allhtml.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ const canonical = doc.querySelector('link[rel=canonical]');
canonical.setAttribute('href',
canonical.getAttribute('href').replace('_toc', 'all'));

const versionPickerLinks = doc.querySelectorAll('ol.version-picker a');
versionPickerLinks.forEach((versionPicker) => {
versionPicker.setAttribute(
'href',
versionPicker.getAttribute('href').replace('_toc', 'all')
);
});

doc.querySelector('body').setAttribute('id', 'api-section-all');

const owner = doc.ownerDocument;
Expand Down