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, GitHub Actions commits the xml files to the xml folder. The GitHub Actions build of this repo will then take care of generating the pages, and then deploy.

development info

To generate the pages locally, run earthly +html.

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...