gdscript2rest 0.5.0

Create API documentation in reStructuredText from Godot GDScript files

GDScript reStructuredText Docs Maker

gdscript2rest is a tool to document your Godot gdscript files into reStructuredText (.rst) files and to create an index of the generated files if required.

The code is based on the gdscript-docs-maker code from GDQuest and, in as far as the initial stages of the conversion are concerned, it is a direct copy of their code with a few notable exceptions:

• This version only provides reStructuredText (.rst) output - if you require markdown or Hugo output then please follow the above link and use the original version.
• As there is no facility to create markdown or Hugo files the -f/--format and -a/--author options in the original are no longer available.
• Multi-line comments in the code are concatenated to single line comments unless there are multiple line breaks, in which case the line breaks are preserved. This is to give, hopefully, a better flow of the description text.

---

Usage

A JSON file of the Godot projects docstrings has to be created first using either the generate-reference script on homepage or the original at gdscript-docs-maker code. Both locations have instructions on how to do this.

Once the JSON file has been created then the reStructuredText documents can be created by running

python -m gdscript2rest [options] $JSON-dump.json

where $JSON-dump.json is the file created by generate-reference.

The above command will generate the files required and place them in a folder called export that is a sub folder of the Current Working Directory.

Running

python3 -m gdscript2rest -h

will give full program usage with detailing options for tailoring the output location and generating an index file.

My Homepage has full instructions, a mini tutorial wiki's as well as a wiki on creating a Sphinx based webpage of your Games API.

Don't hesitate to raise issues or ask questions and if you like this tool then please spread the word!