Forums

yuidocjs https://github.com/apm/yuidocjs is seriously awesome. I've started using it to document my gallery modules and I have a couple questions. So far, I let it generate an api directory in the module's directory and I check it in with the source. I see other modules take different approaches to api docs; is there a best practice or recommended way to provide documentation?

Is there a way I can get GitHub to serve the index file as text/html? Github is already publicly hosting the files, it would be great if it was a functional website.

Is there a way to get yuidocjs to reference more stuff when it builds documentation? For example when my module extends Y.Base, it doesn't pull in inherited attributes/events/methods and the link to the Base class documentation becomes a broken link. I would like it to be able to reference Y.Base without having to include all of YUI's source in my documentation. It would be very nice if it could just pull it from yuilibrary.com.

I was wondering about the fork. There are a couple of bugs that have been fixed on the apm branch (https://github.com/apm/yuidocjs/issues/5 and https://github.com/apm/yuidocjs/issues/12) that are keeping us from rolling this out using your fork. Any plans to merge those fixes over?

I want to say thank you a lot for the job you have made in writing this piece of writing. I am hoping the same most reliable work from you down the road too.