tools: improve docopen target in Makefile #9436
Closed
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
|
|
|
LGTM |
danbev
approved these changes
Nov 4, 2016
2814d93
to
9c89d90
Compare
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file.
9c89d90
to
31c40a7
Compare
|
@jasnell This actually improves |
|
@danbev Can you PTAL again? I changed it a little bit now. |
|
@thefourtheye LGTM |
jasnell
approved these changes
Nov 7, 2016
silverwind
approved these changes
Nov 11, 2016
| @@ -336,8 +335,8 @@ out/doc/api/%.html: doc/api/%.md | ||
| fi | ||
| [ -x $(NODE) ] && $(NODE) $(gen-html) || node $(gen-html) | ||
|
|
||
| docopen: out/doc/api/all.html | ||
| -google-chrome out/doc/api/all.html | ||
| docopen: $(apidocs_html) |
There was a problem hiding this comment.
Maybe rename these to doc-open so it's consistent with doc-only above?
There was a problem hiding this comment.
@silverwind Actually doc-only is the odd man here I guess. Because we have docclean as well :D
There was a problem hiding this comment.
Maybe we can sidestep this issue by makeing doc do what doc-only does now. The fact that doc does a full build seems unexpected. Can be done in another PR I assume.
There was a problem hiding this comment.
@silverwind I agree.
|
Ping @nodejs/collaborators! I'll land this tomorrow if there are no objections. |
|
Landed in c5678d3 |
thefourtheye
added a commit
that referenced
this issue
Nov 17, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
thefourtheye
added a commit
to thefourtheye/io.js
that referenced
this issue
Nov 17, 2016
Building node binary is not necessary for doc builds. Refer: nodejs#9436 (comment)
2 tasks
addaleax
pushed a commit
that referenced
this issue
Nov 22, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins
pushed a commit
that referenced
this issue
Dec 13, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins
pushed a commit
that referenced
this issue
Dec 13, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins
pushed a commit
that referenced
this issue
Dec 21, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins
pushed a commit
that referenced
this issue
Dec 21, 2016
1. As it is, it just tries to build only the `all.html` file. If none of the other files are built already, generated page will not be good. To fix this, we process the assets and generate HTML files first. 2. After the HTML is generated, `google-chrome` is used to open the generated file in browser. This is not very portable as it might not be installed or installations might have used a different name. So, we use Python's webbrowser module to open the file. PR-URL: #9436 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
Merged
Merged
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.
Checklist
Affected core subsystem(s)
tools Makefile
Description of change
As it is, it just tries to build only the
all.htmlfile. If none ofthe other files are built already, generated page will not be good.
To fix this, we process the assets and generate HTML files first.
After the HTML is generated,
google-chromeis used to open thegenerated file in browser. This is not very portable as it might not
be installed or installations might have used a different name. So,
we use Python's webbrowser module to open the file.
cc @nodejs/documentation @nodejs/build