https://github.com/haxefoundation/dox
Haxe documentation generator.
https://github.com/haxefoundation/dox
documentation-generator documentation-tool haxe
Last synced: 3 months ago
JSON representation
Haxe documentation generator.
- Host: GitHub
- URL: https://github.com/haxefoundation/dox
- Owner: HaxeFoundation
- License: mit
- Created: 2013-05-23T12:10:00.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-09-26T20:26:53.000Z (about 1 year ago)
- Last Synced: 2025-06-06T03:41:53.122Z (4 months ago)
- Topics: documentation-generator, documentation-tool, haxe
- Language: Haxe
- Size: 5.43 MB
- Stars: 149
- Watchers: 14
- Forks: 37
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Dox
[](https://github.com/HaxeFoundation/dox/actions?query=workflow%3ACI)
[](https://lib.haxe.org/p/dox)
[](https://lib.haxe.org/p/dox)
[](LICENSE.md)
A Haxe documentation generator used by many popular projects such as:
- [Haxe](https://api.haxe.org/)
- [OpenFL](https://api.openfl.org/)
- [HaxeFlixel](https://api.haxeflixel.com/)
- [Heaps](https://heaps.io/api/)
- [Kha](http://api.kha.tech/)
- [Ceramic](https://ceramic-engine.com/api-docs/)
## Installation
Install the library via [haxelib](https://lib.haxe.org/p/dox):
```sh
haxelib install dox
```
## Usage
> **Note:** Dox requires Haxe 3.1 or higher due to some minor changes in
abstract rtti xml generation. You'll also need an up-to-date haxelib
(requires support for `classPath` in _haxelib.json_)
1. Compile the code to be included in the documentation using:
```sh
haxe -xml docs/doc.xml -D doc-gen [LIBS]
```
E.g.
```sh
haxe -xml docs/doc.xml -D doc-gen --lib hxargs --classpath src -java bin my.aweseome.package
```
2. Generate the HTML pages using:
```sh
haxelib run dox -i
```
...where `input_dir` points to the directory containing the generated .xml file(s) of the previous step, i.e.
```sh
haxelib run dox -i docs
```
**:clipboard: For more details, custom theme creation and options [check out the Dox wiki](https://github.com/HaxeFoundation/dox/wiki/)**
## Local development
To test Dox locally, clone the git repo, run `npm install` in root directory. This installs the correct Haxe version using lix and all required dependencies.
After that you can run:
```sh
npx haxe --run Make dox xml pages server
```
This compiles Dox, creates XML's, generates the pages and starts a local dev server at .
## Local development - testing with nektos/act
The GitHub workflow can be run locally using Nekto's [act](https://github.com/nektos/act) command-line tool. To use it:
1. Install docker
1. Install [act](https://github.com/nektos/act)
1. Navigate into the root of your project (where the .github folder is located)
1. Run the command `act`
1. On subsequent re-runs you can use `act -r` to reuse previous container which avoids re-installation of components and thus greatly reduces build time.