https://github.com/goostengine/goost-docs
Goost official documentation
https://github.com/goostengine/goost-docs
godotengine
Last synced: about 1 year ago
JSON representation
Goost official documentation
- Host: GitHub
- URL: https://github.com/goostengine/goost-docs
- Owner: goostengine
- License: other
- Created: 2020-06-21T14:40:51.000Z (about 6 years ago)
- Default Branch: gd3
- Last Pushed: 2022-05-12T10:24:27.000Z (about 4 years ago)
- Last Synced: 2025-03-11T07:28:04.976Z (over 1 year ago)
- Topics: godotengine
- Language: reStructuredText
- Homepage: https://goost.readthedocs.io/
- Size: 1.26 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Goost documentation
[](https://goost.readthedocs.io/en/latest/?badge=gd3)
This repository contains the source files of
[Goost](https://github.com/goostengine/goost)'s documentation.
See [Godot Engine Documentation](https://github.com/godotengine/godot-docs)
for existing documentation writing workflow and other instructions.
## Goost-specific instructions
### Building documentation
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](https://goost.readthedocs.io/en/latest/).
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
```
### Generating class reference
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/`.