Forums

Peter, currently I am waiting on IO to be functional again in YUI on Node. Once that works, you will be able to set a config option like this in your yuidoc.json file (this does not work yet):



Then when YUIDoc builds the docs, it will fetch and mix this external data with the internal parsed data crosslinking those objects out to our site.

If you don't mind hacking your node_modules until that's fixed, you can edit yuidocjs to allow you to point at a local data.json and a remote webhost.

In your yuidocjs module directory, go open lib/builder.js and comment out the line that looks like this:



Then, you should be able to do this in your doc config:



As a note: this won't include inherited methods or properties from the external modules, and the @use keyword won't link remotely. It will provide remote links to the classes you're extending.

As a further note: I would find the above case--pointing at a local data.json and a remote documentation source--immensely useful. The data.json file is 3.6 meg and it needs to be downloaded any time you want to build the docs, which takes a non-zero amount of time. Pointing at a local json file and assuming it's up-to-date would be a handy trick.