Skip to content

Conversation

@DerekNonGeneric
Copy link
Contributor

@DerekNonGenericDerekNonGeneric commented Aug 30, 2020

This patch improves the means by which the docs are viewed locally.

  • Remove extraneous code in the docserve Makefile target
  • Document the docserve task for all to know
  • Bring all code snippets in this section up to speed
  • Clarify the purpose of each documentation browsing method

Fixes: #34977

@nodejs-github-botnodejs-github-bot added build Issues and PRs related to build files or the CI. doc Issues and PRs related to the documentations. labels Aug 30, 2020
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977
@DerekNonGeneric
Copy link
ContributorAuthor

DerekNonGeneric commented Aug 30, 2020

Welp, not much of a diff anymore in light of #34977 (comment), but this does indeed work on my machine for some reason and speculate that it's due to having run ./configure beforehand, which was able to identify my correct Python version.

@richardlau
Copy link
Member

configure will write the detected Python into config.mk, which is included in the Makefile

-include config.mk

@codecov-commenter
Copy link

Codecov Report

Merging #34986 into master will increase coverage by 0.01%.
The diff coverage is 89.00%.

Impacted file tree graph

@@ Coverage Diff @@## master #34986 +/- ## ========================================== + Coverage 96.67% 96.69% +0.01%  ========================================== Files 208 207 -1 Lines 68993 69126 +133 ========================================== + Hits 66701 66841 +140 + Misses 2292 2285 -7 
Impacted FilesCoverage Δ
lib/internal/errors.js97.97% <50.00%> (+0.13%)⬆️
lib/internal/modules/esm/resolve.js94.53% <80.00%> (+<0.01%)⬆️
lib/internal/policy/manifest.js86.53% <87.66%> (+8.13%)⬆️
lib/internal/modules/cjs/loader.js94.71% <90.90%> (+<0.01%)⬆️
lib/perf_hooks.js96.00% <94.11%> (+0.04%)⬆️
lib/_stream_readable.js99.01% <100.00%> (+<0.01%)⬆️
lib/internal/modules/esm/get_source.js90.47% <100.00%> (+5.11%)⬆️
lib/internal/modules/package_json_reader.js100.00% <100.00%> (ø)
lib/internal/process/execution.js98.09% <100.00%> (-0.07%)⬇️
lib/net.js95.29% <100.00%> (-0.01%)⬇️
... and 4 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a1faa8d...94b75aa. Read the comment docs.

@mmarchini

This comment has been minimized.

@DerekNonGeneric
Copy link
ContributorAuthor

@mmarchini, I've clarified the prose a bit, PTAL.

@DerekNonGeneric
Copy link
ContributorAuthor

There's still some sort of a bug here. It's not working as I would expect. I should be able to run:

make docclean make docserve

However, instead, I get this error:

Error: ENOENT: no such file or directory, open 'out/doc/apilinks.json' at Object.openSync (fs.js:457:3) at Object.writeFileSync (fs.js:1282:35) at Object.<anonymous> (/mnt/c/orgs/nodejs/node-runtime/tools/doc/apilinks.js:211:4) at Module._compile (internal/modules/cjs/loader.js:1157:30) at Object.Module._extensions..js (internal/modules/cjs/loader.js:1177:10) at Module.load (internal/modules/cjs/loader.js:1001:32) at Function.Module._load (internal/modules/cjs/loader.js:900:14) at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:74:12) at internal/main/run_main_module.js:18:47{errno: -2, syscall: 'open', code: 'ENOENT', path: 'out/doc/apilinks.json' } 

This is evidence that #34986 (comment) needs to be addressed first.

@aduh95aduh95 mentioned this pull request Sep 4, 2020
2 tasks
Co-authored-by: Antoine du Hamel <[email protected]>
@DerekNonGeneric
Copy link
ContributorAuthor

Landed in ff0aad0

richardlau pushed a commit that referenced this pull request Sep 7, 2020
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <[email protected]>
@richardlaurichardlau mentioned this pull request Sep 7, 2020
4 tasks
richardlau pushed a commit that referenced this pull request Sep 7, 2020
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <[email protected]>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: #34977 PR-URL: #34986 Reviewed-By: Richard Lau <[email protected]>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
joesepi pushed a commit to joesepi/node that referenced this pull request Jan 8, 2021
This patch improves the means by which the docs are viewed locally. * Remove extraneous code in the `docserve` Makefile target * Document the `docserve` task for all to know * Bring all code snippets in this section up to speed * Clarify the purpose of each documentation browsing method Fixes: nodejs#34977 PR-URL: nodejs#34986 Reviewed-By: Richard Lau <[email protected]>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.buildIssues and PRs related to build files or the CI.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tools: the docserve make target doesn't seem to finally serve

7 participants

@DerekNonGeneric@richardlau@codecov-commenter@mmarchini@Trott@aduh95@nodejs-github-bot