-
Notifications
You must be signed in to change notification settings - Fork 1.8k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add JSDoc HTML output and fix JSDoc tags #1086
Conversation
…y. Add grunt-jsdoc & ink-docstrap
This looks great and I'm going to merge it, but it's definitely a work-in-progress, so I'm going to see if I can avoid publishing the generated output for now. (We'll see if Random observations (I haven't looked very thoroughly):
|
Oh I see you linked to an issue about the absolute paths. It's weird that we would see that on OSX when the developer is on Linux and the other reporters are on Windows. |
Merged in 2.0 beta 26. Thanks @mtraynham! |
@gordonwoodhull No worries, there is a way we can configure the documents to remove the "DocStrap" stuff. I believe we need a config file like:
And then you specify this in the Grunt spec:
|
In regards to that source path bug (krampstudio/grunt-jsdoc#135), I did find that if you pre-concatenated everything it worked. But that made the source lookup extremely slow because it was all attached to one file instead of multiple... Also, maybe there is a different decorator to work with the namespaces, I just didn't find one... |
Looks good, hope to try the config file soon. I'm sure the other problems are solvable too, it's just that these are big old tools and it's a lot of work just to figure out how to use them right. The docs are getting big, so pagination is going to be helpful. |
Thanks @mtraynham, the config helps. I'll open issues for the other problems. It was nice to hear from @75lb on #1054 and start to understand why our markdown documentation may not be working so well inside the GitHub UI. I'm thinking that we should stop trying to use GitHub as our documentation viewer! |
I've added HTML JSDoc output. It dumps to
./web/docs/html
, with the main html filedc.html
. During this exercise, I realized that using the@name
annotation was not completely correct in most cases, and should have been@namespace
for nested objects offdc
's root and@method
for functions.There are two outstanding issues with this.
Absolute paths used on Windows krampstudio/grunt-jsdoc#135
I didn't actually check in the generated files, but I figured you could do that @gordonwoodhull since it may make merging up to
develop
harder with theapi-latest.md
being changed as well.Attaching some pictures 😄