diff options
author | Sam Ruby <rubys@intertwingly.net> | 2018-08-19 14:03:21 -0400 |
---|---|---|
committer | Sam Ruby <rubys@intertwingly.net> | 2018-08-29 22:20:46 -0400 |
commit | 60465700ed055640e737ca3a53e16465dfec00d6 (patch) | |
tree | e5485fd7f1ab26b7fd0eee1aeb2fb98b098a59a1 /test/doctool/test-doctool-html.js | |
parent | 8569f4a4178d1a114a95aabcb27cb30cb265e621 (diff) | |
download | android-node-v8-60465700ed055640e737ca3a53e16465dfec00d6.tar.gz android-node-v8-60465700ed055640e737ca3a53e16465dfec00d6.tar.bz2 android-node-v8-60465700ed055640e737ca3a53e16465dfec00d6.zip |
tools: Include links to source code in documentation
Parse source code using acorn; extracting exports. When producing
documentation, match exports to headers. When a match is found, add a [src]
link.
This first commit handles simple exported classes and functions, and does so
without requiring any changes to the source code or markdown. Subsequent
commits will attempt to match more headers, and some of these changes are
likely to require changes to the source code and/or markdown.
PR-URL: https://github.com/nodejs/node/pull/22405
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Refael Ackermann <refack@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'test/doctool/test-doctool-html.js')
-rw-r--r-- | test/doctool/test-doctool-html.js | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/test/doctool/test-doctool-html.js b/test/doctool/test-doctool-html.js index 8c05ea6a0b..2fcb8315af 100644 --- a/test/doctool/test-doctool-html.js +++ b/test/doctool/test-doctool-html.js @@ -28,7 +28,7 @@ function toHTML({ input, filename, nodeVersion, analytics }, cb) { .use(html.firstHeader) .use(html.preprocessText) .use(html.preprocessElements, { filename }) - .use(html.buildToc, { filename }) + .use(html.buildToc, { filename, apilinks: {} }) .use(remark2rehype, { allowDangerousHTML: true }) .use(raw) .use(htmlStringify) |