Skip to content

tools,doc: fix version picker in docs to show all available versions #33466

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

tools,doc: fix version picker in docs to show all available versions #33466

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
f563fb2
tools,doc: move version picker to external file
Trott May 19, 2020
ee52f24
tools: move version picker script to main doc directory
Trott May 19, 2020
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
tools: move version picker script to main doc directory 
Move the version picker JavaScript file to the main doc directory so all
versions of the documentation can share it.

This is a step in addressing the issue of making all versions of a doc
available to all versions that have it in the version picker.

Refs: #32077
  • Loading branch information
@Trott
Trott committed May 19, 2020
commit ee52f240caaca9d4015802a07ff021a126e65f10
3 changes: 2 additions & 1 deletion tools/doc/generate.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,8 @@ async function main() {
const basename = path.basename(filename, '.md');
const htmlTarget = path.join(outputDir, `${basename}.html`);
const jsonTarget = path.join(outputDir, `${basename}.json`);
const versionPickerTarget = path.join(outputDir, `.${basename}.versions.js`);
const versionPickerTarget =
path.join(outputDir, '..', `.${basename}.versions.js`);

return Promise.allSettled([
fs.writeFile(htmlTarget, myHtml),
Expand Down
2 changes: 1 addition & 1 deletion tools/doc/html.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ function toHTML({ input,
return `document.write('${htmlPayload}')`;
}

const versionsJS = `.${filename}.versions.js`;
const versionsJS = `../.${filename}.versions.js`;
return HTML.replace('__ALTDOCS__', `<script src="${versionsJS}"></script>`);
}

Expand Down