GDScript Docs Maker 1.0.0

This is the first release of our tool to create a code reference for your Godot GDScript code.

Features

• Parses and collects docstrings from GDScript files, using Godot 3.2's Language Server. Outputs the data as JSON.
• Converts the JSON data to markdown files.
  • Writes methods, static functions, signals, member variables, and class data.
  • Only writes relevant sections. For example, the tool only creates a "Method Descriptions" section if there are methods in the class.
  • Skips built-in callbacks, i.e. _process, _input, etc.
  • Skips the constructor, _init, unless it has arguments.
  • Skips private functions and member variables, unless tagged as virtual.
• Supports tags in the source code with the tags: keyword followed by comma-separated strings, like tags: virtual, deprecated.
  • Currently, the program only takes virtual into account, but it does store all the tags.
• There are two shell scripts for POSIX shells (sh, bash, etc.) and Windows CMD, respectively. Use them to generate your code reference instantly.

Installing

You can install GDScript Docs Maker with pip:

# On Linux and MacOS:
python3 -m pip install gdscript_docs_maker

# On Windows, if you installed Python 3.7+, you can use:
python -m pip install gdscript_docs_maker

Getting started

Read our README on the repository's home page

Your feedback

If you encounter a bug or you have an idea to improve the tool, please open an issue!

Also, check out our GDQuest contributor's guidelines

Support us

Our work on Free Software is sponsored by our Godot game creation courses. Consider getting one to support us!

Join the community

• You can join the GDQuest community and come chat with us on Discord
• For quick news, follow us on Twitter
• We release video tutorials and major updates on YouTube

We hope you'll find GDScript Docs Maker useful!