Add single script to build docs and call it when combined with jsdoc. #380
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
We'll need this to fix stellar-deprecated/developers#117. The developers script call `/node_modules/.bin/jsdoc -c .jsdoc.json --explain` [here](https://github.com/stellar/developers/blob/1c753962b44472fcda43f25324685f9629971907/gulp/code-symbol-tags.js#L24) -- but in order for it to work properly, we need to call `gulp build:docs` first it generated the libdocs files which have the final sources after transpilation.
abuiles
added a commit
to stellar-deprecated/developers
that referenced
this pull request
Jul 23, 2019
Fixes #117 - the reason for the broken build was that the command `/node_modules/.bin/jsdoc -c .jsdoc.json --explain` relied on `libdocs` existing. But it only gets created after running `yarn build:docs`. It used to work because the `jsdoc.config` file was using the `src` directory, but with the move to TypeScript, we need to use `libdocs` which contains the transpiled source code - [see this change](stellar/js-stellar-sdk@bf3b62e#diff-4c4e0bb5af5bd36c5762fb0883ef0752R3). Depends on stellar/js-stellar-sdk#380
ire-and-curses
approved these changes
Jul 23, 2019
abuiles
added a commit
to stellar-deprecated/developers
that referenced
this pull request
Jul 23, 2019
Fixes #117 - the reason for the broken build was that the command `/node_modules/.bin/jsdoc -c .jsdoc.json --explain` relied on `libdocs` existing. But it only gets created after running `yarn build:docs`. It used to work because the `jsdoc.config` file was using the `src` directory, but with the move to TypeScript, we need to use `libdocs` which contains the transpiled source code - [see this change](stellar/js-stellar-sdk@bf3b62e#diff-4c4e0bb5af5bd36c5762fb0883ef0752R3). Depends on stellar/js-stellar-sdk#380
|
Is the mixing of |
Yes, it is okay - gulp does the build, yarn manages the deps and let us call |
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.
We'll need this to solve stellar-deprecated/developers#117.
The developers script call
/node_modules/.bin/jsdoc -c .jsdoc.json --explainhere -- but in order for it to work properly, we need to callgulp build:docsfirst it generated the libdocs files which have the final sources after transpilation.