Auto-Document GH Libraries

I wrote a little script for myself that I thought might be useful to other GH developers or teachers. Feed it a component from any library (such as a plug-in you're developing), and it will list and describe all the components in that library. It can also generate a markdown-formatted text file, organized by the subcategory tabs in the GH toolbar.

Download it here!

Comment

You need to be a member of Grasshopper to add comments!

Comment by Harsh Gupta on May 18, 2016 at 1:23am: Hi Andrew. Thanks for the well documented GH program! I was able to visualize the data for a UserObj collection (Alba), and export the PNG icons...

However, I am finding it difficult to export the textual lists data properly. When I use the "stream to file" feature, it messes up the data since many component descriptions are multiline, so I have no idea when one description begins and the other ends. Also, multi-dimensional arrays like the InputParamNames gets "flattened" into a single-dimensional list (ie. the tree structure gets flattened into a list) so I cannot tell which inputs are for which components. Am I making sense?

I even investigated saving to text and saving to JSON, but all I could find was ghJSON which IMO does not save lists to JSON. Anyways I just need a better way to save the data. Do you have any?

Comment by Andrew Heumann on May 12, 2016 at 5:19am: I can probably augment the script to include user objects. I'll look into it!

Comment by Harsh Gupta on May 12, 2016 at 5:15am: Are user objects supported too?

Comment by Andrew Heumann on May 12, 2016 at 4:58am: Harsh - glad it will be useful! Be sure to use the updated version I posted on your thread rather than the one here - it has a lot more information.

Comment by Harsh Gupta on May 12, 2016 at 1:55am: This should be helpful for generating plugin documentation! Thanks for supporting the doc effort.