Building docs

This is mostly just a reference for me so I can remember how to build and update the API documentation!

This is the easiest way I've found to create documentation 👍

Step One - Dependencies

haxelib install flixel
haxelib install flixel-addons
haxelib install zerolib
haxelib install dox

Step Two - Create Project

flixel tpl -n "ZerolibDocs"

Project.xml:

<?xml version="1.0" encoding="utf-8"?>
<project>

	<app title="ZeroDocs" file="ZeroDocs" main="Main" version="0.0.1" company="HaxeFlixel" />
	<app preloader="flixel.system.FlxPreloader" />
	<set name="SWF_VERSION" value="11.8" />
	
	<window width="640" height="480" fps="60" background="#000000" hardware="true" vsync="false" />
	<set name="BUILD_DIR" value="export" />
	<classpath name="source" />

	<haxelib name="flixel" />
	<haxelib name="flixel-addons" />
	<haxelib name="zerolib" />
	<haxeflag name="--macro" value='include("zero")' />

</project>

Step Three - Build with -xml

lime build flash -xml

*check to make sure xml file contains the correct classes!

Step Four - Build Docs

haxelib run dox -i export/flash/types.xml -o api/ --title "Zerolib API" --toplevel-package zero

*check site at api/

Step Five - Push to github-pages

Push the contents of api/ to zerolib:gh-pages