THX!
or we could run our own hosted version of doclets . It is based on docker anyway.
true
i think that's the beauty of all these web services
I'll keep an eye on this. If I can help with something let me know.
thanks a lot!
I've been testing out using doclets for the api docs for sequelize.js - And so far its looking good :)!
I was wondering whether it is possible to get an idea of how the docs will look locally so I don't have to commit and wait for it to be regenerated each time?
$ npm install doclets -g
$ cd your-project
$ doclets preview 8090
How is the documentation generated? Does it use the default jsdoc cli, or another parser?
I might try my luck with the jsdoc cli for now then, since most of the errors now are functions ending up in the wrong namespace (actually no namespace at all)
yes, this should work for you. the naming hierarchy is the same as outputed by jsdoc cli. but if not defined, namespaces are auto guessed. A symbol named foo.bar will be nested into an implicitly defined namespace "foo" if it is not existent. But I really recommend to do it explicitly as jsdoc would like to have it.
@lipp Do you have any please for supporting nested arguments in another form than just lists? A lot of sequelize's methods have an options object, which has a lot of optional properties. In regular jsdoc its rendered as a nested table, whereas doclets renders everything in one list
Which sometimes gets very long ;)
Actually, heres a better example, with double nesting
And here's the corresponding on doclets https://doclets.io/janmeier/sequelize/janmaster#dl-all
the problem i see: with each nesting level you somehow indent and thus loose horizontal space, which (after some levels) get unreadable
But all in all you loose space