Forums

Board index » Deprecated: » YUI Doc

Page 1 of 2   [ 14 posts ] Go to page 1, 2 Next
New Topic | Post Reply | Print view

Dav Glass

  • Username: davglass
  • Joined: Thu Aug 28, 2008 9:28 am
  • Posts: 2088
  • Location: Marion, IL, US
  • Twitter: davglass
  • GitHub: davglass
  • Gists: davglass
  • IRC: davglass
  • Offline
  • Profile
Tags:

YUIDoc 0.3.0 is Official

Post Posted: Wed May 09, 2012 12:56 pm
+0-
Today we are pleased to announce the official release of the new YUIDoc, our JavaScript documentation generator. YUIDoc is a Node.js application that generates API documentation from comments in source, using a syntax similar to tools like Javadoc and Doxygen. YUIDoc is currently powering the API documentation for YUI and has been actively updated over the last year.

View the official blog post here

YUIDoc provides:

  • Live previews. YUIDoc includes a standalone doc server, making it trivial to preview your docs as you write.
  • Modern markup. YUIDoc's generated documentation is an attractive, functional web application with real URLs and graceful fallbacks for spiders and other agents that can't run JavaScript.
  • Wide language support. YUIDoc was originally designed for the YUI project, but it is not tied to any particular library or programming language. You can use it with any language that supports `/* */` comment blocks.


Please note that this forum is now deprecated and all support requests should go to the new Mailing List.

Sean Fitzsimmons

  • Username: seanf
  • Joined: Wed Sep 16, 2009 6:16 am
  • Posts: 78
  • Location: Baltimore, Maryland, USA
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 3:46 am
+0-
Dav,

Any hints on how to go about installing YUIDoc on an intranet?

Thanks, Sean

Dav Glass

  • Username: davglass
  • Joined: Thu Aug 28, 2008 9:28 am
  • Posts: 2088
  • Location: Marion, IL, US
  • Twitter: davglass
  • GitHub: davglass
  • Gists: davglass
  • IRC: davglass
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 5:09 am
+0-
Not sure what you mean, YUIDoc generates HTML files that can be hosted anywhere.

Sean Fitzsimmons

  • Username: seanf
  • Joined: Wed Sep 16, 2009 6:16 am
  • Posts: 78
  • Location: Baltimore, Maryland, USA
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 9:31 am
+0-
I have Node.js and npm installed on my local machine on my intranet, but when I run the recommended command:

Code:
npm -g install yuidocjs


I get a bunch of errors. I have no experience with Node.js or npm, but it would seem that it is trying to get to Node.js and/or github. Am I suppose to get the code from git and use npm to install yuidoc? I'm lost. I really would like to get this working since all our JavaScript code is well documented. Having a well formatted version of the docs as with YUI will make life much easier for our developers.

Dav Glass

  • Username: davglass
  • Joined: Thu Aug 28, 2008 9:28 am
  • Posts: 2088
  • Location: Marion, IL, US
  • Twitter: davglass
  • GitHub: davglass
  • Gists: davglass
  • IRC: davglass
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 9:37 am
+0-
Sean --

Can you post the errors? I've never seen and install fail with errors..

You can also join the YUIDoc support forum here:
https://groups.google.com/forum/#!forum/yuidoc

Nick Husher

YUI Contributor

  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 9:58 am
+0-
I also get install errors when attempting to install from npm:

Attempting to install from npm

Click here to see the revision history on this Gist.

Full log here https://gist.github.com/2654760

Dav Glass

  • Username: davglass
  • Joined: Thu Aug 28, 2008 9:28 am
  • Posts: 2088
  • Location: Marion, IL, US
  • Twitter: davglass
  • GitHub: davglass
  • Gists: davglass
  • IRC: davglass
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 10:04 am
+0-
This is why: node -v v0.7.8

0.7.x is the unstable version of Node, 0.6.x is stable & that's what YUIDoc is guaranteed to run against

Alberto Santini

YUI Contributor

  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Thu May 10, 2012 10:09 am
+0-
Hello Nick.

Try with stable release 0.6.17 (vs. 0.7.8).

express module (2.5.9) is incompatible with 0.7.8

On Windows 7 the installations works fine.

Regards,
IceBox

Sean Fitzsimmons

  • Username: seanf
  • Joined: Wed Sep 16, 2009 6:16 am
  • Posts: 78
  • Location: Baltimore, Maryland, USA
  • Offline
  • Profile
Tags:

Re: YUIDoc 0.3.0 is Official

Post Posted: Fri May 11, 2012 3:56 am
+0-
Dav,

I don't think I was being very clear. I cannot reach the outside on my intranet so https://registry.npmjs.org/yuidocjs will fail. I guess I can pull your source from github and figure out how to build it. Still worth the effort since we have a ton of (well documented) JavaScript in our YUI2 based project and no way to generate nice YUI style docs.

Thanks, Sean

Nick Husher

YUI Contributor

  • Offline
  • Profile

Re: YUIDoc 0.3.0 is Official

Post Posted: Fri May 11, 2012 4:41 am
+0-
@Dav and Alberto:

I had Node 0.7.x installed because 0.6.x hated me for some reason. Attempting to roll back to it in homebrew caused peculiar exceptions. After a lot of wrestling (and reinstalling homebrew), I managed to get 0.6 to work.

Seems to work alright now. ;)
Page 1 of 2   [ 14 posts ] Go to page 1, 2 Next
New Topic | Post Reply | Print view
Display posts from previous:  Sort by  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum

Recent Forums Posts

Recent YUI Blog Posts

Online Users

© 2006-2013 Yahoo! Inc. All rights reserved.
All code on this site is licensed under the BSD License unless stated otherwise.
About This Site · Security Contact Info

Powered by phpBB® Forum Software © phpBB Group