Game Development Community

Documentaiton Question for Michael

by Alistair Lowe3 · in iTorque 2D · 03/29/2011 (8:14 am) · 1 replies

@ Michael - Is the reference documentation auto generated or just the individual object pages? Is the bar on the left completely manually pieced together?

I'm looking at possible suggestions to improve the flow but wanted to work with a complete picture.

Cheers

#1
04/07/2011 (7:41 am)
@Alistair - Sorry, just saw this thread.

Quote:Is the reference documentation auto generated or just the individual object pages?
They are currently handwritten. When they are placed in a specific folder, they will automatically get added to the TOC

Quote:Is the bar on the left completely manually pieced together?
Sort of. The doc system generates the table of contents based on two steps. First, it drills through directories and individual html files to create the groupings. It will order then alphabetically unless an order.txt file exists, defining what the order of the TOC should be.