This repository contains the source files of Goost's documentation.
See Godot Engine Documentation for existing documentation writing workflow and other instructions.
Documentation can be built using the same tool which builds Godot Engine:
scons
This will build html pages by default as seen in the
Goost documentation.
If you'd like to build documentation in other formats supported by Sphinx,
run scons --help to retrieve a list of all supported build targets.
For instance, to build a single large HTML file:
scons target=singlehtml
The following assumes that you compile Goost with the scons option, so that
Godot repository is cloned inside Goost repository (default behavior):
cd goost
python goost.py --generate-doc-api "/path/to/goost-docs/classes"
The above will generate the class reference using Godot's makerst tool
automatically, along with Goost components information included in
components/.