andyli / api.haxe.org

Haxe API documentation

api.haxe.org - Haxe Standard API documentation website

This repository hosts the api.haxe.org website.

As an overview, a program in the master branch takes the documentation xml files generated by the Haxe compiler and turn them into html pages using dox.

For every commit in the development branch and tags in the haxe repo, TravisCI commits the xml files to the xml folder. The TravisCI build of this repo will then take care of generating the pages, and than commit the output to the gh-pages branch, which is the source of GitHub Pages.

development info

To generate the pages locally, run the commands in .travis.yml, except you don't run the haxe --run DeployGhPages line at the end for obvious reason.

The html/css/js template files reside in the theme folder. The theme inherits dox default.

The haxelib dependencies are managed as submodules in the libs folder. We do not use lib.haxe.org just because we often evolve the dependencies in parallel to Haxe development, and it is troublesome to make proper releases...

To keep the repository size reasonable, we only keep the last several commits of the gh-pages branch. This means we are constantly rewriting the history of gh-pages. As a result, pulling gh-pages doesn't make much sense. Use git fetch && git checkout gh-pages && git reset --hard origin/gh-pages if you want to get an updated copy of the gh-pages branch.