build, doc: use new api doc tooling #57343
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Review requested:
|
nodejs-github-bot
added
build
flakey5
force-pushed
the
flakey5/20250305/api-docs-tooling
branch
from
77ede22 to
3423c21
Compare
flakey5
commented
Mar 6, 2025
| else \ | ||
| $(MAKE) out/doc/api/all.html out/doc/api/all.json out/doc/api/stability; \ | ||
| $(call available-npx, --prefix tools/doc api-docs-tooling -t legacy-html-all legacy-json-all api-links -i doc/api/\*.md -i lib/\*.js -o out/doc/api/ -c file://$(PWD)/CHANGELOG.md) \ |
There was a problem hiding this comment.
@ovflowd how do we wanna handle the skip_apidoc_files above?
Switches over to using the new doc generation tooling. For more background on this, please see nodejs#52343 Signed-off-by: flakey5 <[email protected]> Co-authored-by: Claudio W <[email protected]>
flakey5
commented
Mar 6, 2025
| for %%F in (%config%\doc\api\*.md) do ( | ||
| %node_exe% tools\doc\generate.mjs --node-version=v%FULLVERSION% %%F --output-directory=%%~dF%%~pF | ||
| ) | ||
| %npx_exe% --prefix tools/doc api-docs-tooling -t legacy-html-all legacy-json-all api-links -i doc/api/*.md -i lib/*.js -o out/doc/api/ |
There was a problem hiding this comment.
need to see how the changelog flag works on windows
flakey5
force-pushed
the
flakey5/20250305/api-docs-tooling
branch
from
3423c21 to
451f8a7
Compare
flakey5
commented
Mar 6, 2025
| @@ -1,108 +0,0 @@ | |||
| Here's how the node docs work. | |||
There was a problem hiding this comment.
might be helpful to keep this?
There was a problem hiding this comment.
-1 to keep here but +1 to have something like that in nodejs/api-docs-tool
Signed-off-by: flakey5 <[email protected]>
ovflowd
reviewed
Mar 6, 2025
There was a problem hiding this comment.
@flakey5 I guess you also need to check our GitHub Action Workflows, and also other mentions of these files within the source.
Like within the Contributor Docs, there is a file that describes how the legacy API doc tooling works, and I believe there are other references also.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Switches over to using the new doc generation tooling. For more background on this, please see #52343
Currently a draft just to get feedback on the approach to this integration.
cc @nodejs/web-infra