delta/node-new.git/test/doctool, branch stabilize-modules

test: add common.mustSucceed

2020-10-16T22:48:26+00:00

PR-URL: https://github.com/nodejs/node/pull/35086
Reviewed-By: Ruy Adorno 
Reviewed-By: Rich Trott

doc: use .md extension for internal links

2020-10-01T13:19:12+00:00

This helps catch broken links as part of the test suite. This also
improves the user experience when browsing the markdown files.

PR-URL: https://github.com/nodejs/node/pull/35191
Fixes: https://github.com/nodejs/node/issues/35189
Reviewed-By: Derek Lewis 
Reviewed-By: Jiawen Geng 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Richard Lau 
Reviewed-By: Rich Trott

tools,doc: allow page titles to contain inline code

2020-09-03T13:36:03+00:00

Previously the HTML title would be cut to the first text node only.

PR-URL: https://github.com/nodejs/node/pull/35003
Reviewed-By: Richard Lau 
Reviewed-By: Rich Trott 
Reviewed-By: Derek Lewis

doc: use _Static method_ instead of _Class Method_

2020-08-09T14:02:28+00:00

Our docs describe static methods as Class Methods which seems
idiosyncratic for JavaScript. Align with MDN which calls them static
methods.

Refs: https://developer.mozilla.org/en-US/docs/MDN/Contribute/Structures/API_references/What_does_an_API_reference_need

JSON format for our docs will still use the key name `classMethods` for
this. I would like to change it to `staticMethods` but I don't know if
that will break things for consumers. So, leaving it alone. It's a
machine-consumable label more than a human-readable so I can live with
that.

PR-URL: https://github.com/nodejs/node/pull/34659
Reviewed-By: Michaël Zasso 
Reviewed-By: James M Snell 
Reviewed-By: Gerhard Stöbich 
Reviewed-By: Luigi Pinca 
Reviewed-By: Trivikram Kamat

doc: add dynamic source code links

2020-06-26T17:25:14+00:00

Fixes: https://github.com/nodejs/node/pull/33977

PR-URL: https://github.com/nodejs/node/pull/33996
Reviewed-By: Rich Trott 
Reviewed-By: James M Snell

test: fix tool path in test-doctool-versions.js

2020-04-05T19:18:31+00:00

Path to the versions tool tested by test-doctool-versions.js would
be incorrect if the test temporary directory was redirected (e.g.
via NODE_TEST_DIR) outside of `test/`.

Signed-off-by: Richard Lau 

PR-URL: https://github.com/nodejs/node/pull/32645
Refs: https://github.com/nodejs/node/pull/32518
Reviewed-By: Colin Ihrig 
Reviewed-By: Shelley Vohr 
Reviewed-By: Anna Henningsen

tools: only fetch previous versions when necessary

2020-03-31T22:25:10+00:00

Refactor the logic for working out the previous versions of Node.js for
the API documentation so that the parsing (including the potential https
get) happens at most once per build (as opposed to the current once per
generated API doc).

Signed-off-by: Richard Lau 

PR-URL: https://github.com/nodejs/node/pull/32518
Fixes: https://github.com/nodejs/node/issues/32512
Reviewed-By: Joyee Cheung 
Reviewed-By: Myles Borins

tools: update JSON header parsing for backticks

2020-01-12T15:10:33+00:00

Methods, events, and so on in headers in our documentation may (and
should) be set off with backticks in the raw markdown. When that
happens, the headers is misinterpreted by tools/json.js as not being a
method or event. Update the JSON tool generator to accommodate backticks
in this situation and add a test for this situation.

Fixes: https://github.com/nodejs/node/issues/31290

PR-URL: https://github.com/nodejs/node/pull/31294
Reviewed-By: Richard Lau 
Reviewed-By: Anna Henningsen 
Reviewed-By: Luigi Pinca

tools: add unified plugin changing links for html docs

2019-11-30T17:17:56+00:00

This commit introduces additional stage in the process of generating
html docs from markdown files. Plugin transforms links to *.md files
in the respository to links to *.html files in the online documentation.

Fixes: https://github.com/nodejs/node/issues/28689

PR-URL: https://github.com/nodejs/node/pull/29946
Reviewed-By: Anna Henningsen

tools: make doctool work if no internet available

2019-11-06T03:10:33+00:00

Allow doctool to fallback to use local files if not building a release
build.

PR-URL: https://github.com/nodejs/node/pull/30214
Fixes: https://github.com/nodejs/node/issues/29918
Reviewed-By: Rich Trott 
Reviewed-By: Gus Caplan 
Reviewed-By: Chengzhong Wu 
Reviewed-By: Joyee Cheung 
Reviewed-By: Ruben Bridgewater 
Reviewed-By: Jiawen Geng