docs: jsdoc + travis auto build to gh-pages.#127
Conversation
|
Let me know if/when this is merge-worthy, and I'll do a rebase and rebuild of the docs so we're current. |
|
Oh, I thought it was still WIP from the commit message :) Looks good to me, please go forward. I'll then make some tweaks that we'll discuss later! |
cc6dfcc to
d27dfad
Compare
|
Re-built :) |
|
Is it possible to remove TODOs and private types/members/methods from docs? We should generate docs only for user-facing stuff. |
|
Poll time! Do you think the docs should be: var dataset = new Dataset(){};or a real use case: var gcloud = require('gcloud');
var dataset = new gcloud.datastore.Dataset({});? |
|
I vote real use case. |
|
I vote for the real use case too. Maybe we don't need to mention |
|
Holy moly, the big PR is updated! http://stephenplusplus.github.io/gcloud-node/ for a preview. |
|
Looks great! |
|
Great, thanks! |
docs: jsdoc + travis auto build to gh-pages.
work in progress
RE: #125
Preview:
JSDoc-rendered HTML: http://stephenplusplus.github.io/gcloud-node
Readme changes: https://github.com/stephenplusplus/gcloud-node/tree/docs