Switch gulp docs to build its output using documentation.js
#1545
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
dbemiller
suggested changes
Aug 30, 2017
There was a problem hiding this comment.
Since you're adding stuff to package.json, we should update the yarn lockfile too.
There's probably a faster way... but I always do:
rm -rf node_modules
rm yarn.lock
yarn install
git add yarn.lock
If you don't have yarn installed and don't wanna be bothered by it, let me know and I can do it.
package.json
Outdated
| @@ -51,7 +51,8 @@ | |||
| "gulp-footer": "^1.0.5", | |||
| "gulp-header": "^1.7.1", | |||
| "gulp-if": "^2.0.2", | |||
| "gulp-jsdoc-to-markdown": "^1.2.1", | |||
| "gulp-documentation": "3.2.1", | |||
| "documentation": "5.2.2", | |||
There was a problem hiding this comment.
Let's move documentation above, to keep this mammoth list of dev-depdendencies alphabetized.
Also: Stick a ^ before the version (like the surrounding ones). That makes it download the latest version, up until the library makes a breaking change that we actually have to pay attention to..
There was a problem hiding this comment.
Thanks @dbemiller ! Made all requested changes:
- Alphabetize package list
- Add "^" to versions
- Update
yarn.lock
added 2 commits
August 31, 2017 10:32
Specifically: - Alphabetize list of deps - Prepend "^" to package versions
dbemiller
approved these changes
Aug 31, 2017
dbemiller
approved these changes
Sep 5, 2017
matthewlane
approved these changes
Sep 6, 2017
outoftime
pushed a commit
to Genius/Prebid.js
that referenced
this pull request
Sep 18, 2017
…built * 'master' of https://github.com/prebid/Prebid.js: (46 commits) Serverbid alias (prebid#1560) Add user sync to process for approving adapter PRs (prebid#1457) fix travis build (prebid#1595) Rubicon project improvement/user sync (prebid#1549) Adding Orbitsoft adapter (prebid#1378) Fix renderer test for new validation rule (prebid#1592) Allow SET_TARGETING to be used in AnalyticsAdapter (prebid#1577) Add support for video stream context (prebid#1483) Invalidate bid if matching bid request not found (prebid#1575) allow adapters to set default adserverTargeting for specific bid (prebid#1568) Custom granularity precision should honor 0 if it is passed in closes prebid#1479 (prebid#1591) BaseAdapter for the Prebid 0.x -> 1.x transition (prebid#1494) Add a version to the Criteo adapter (prebid#1573) Allow bundling from node.js or with new gulp task bundle-to-stdout (prebid#1570) Add url.parse option to not decode the whole URL (prebid#1480) Tremor Video Bid Adapter (prebid#1552) Yieldmo bid adapter (prebid#1415) Switch `gulp docs` to build its output using documentation.js (prebid#1545) Increment pre version Prebid 0.28.0 Release ...
jbAdyoulike
pushed a commit
to jbAdyoulike/Prebid.js
that referenced
this pull request
Sep 21, 2017
…#1545) * Use 'gulp-documentation' instead of jsdoc2md * Build Markdown instead (more versatile) * Update package.json per review feedback Specifically: - Alphabetize list of deps - Prepend "^" to package versions * Update yarn.lock alongside package.json
dluxemburg
pushed a commit
to Genius/Prebid.js
that referenced
this pull request
Jul 17, 2018
…#1545) * Use 'gulp-documentation' instead of jsdoc2md * Build Markdown instead (more versatile) * Update package.json per review feedback Specifically: - Alphabetize list of deps - Prepend "^" to package versions * Update yarn.lock alongside package.json
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.
Type of change
Description of change
Change from using the gulp JSDoc to Markdown plugin to the
gulp-documentationplugin, which drives documentation.js.Rationale for the change is that documentation.js generates much more complete API doc output from
src/prebid.jsgiven the same source file contents (see examples attached below for comparison).documentation-js-API.txt
jsdoc-readme.txt
Other information
More preliminary work towards achieving #1408