Skip to content

GDScript Docs Maker v1.2.1

Compare
Choose a tag to compare
@NathanLovato NathanLovato released this 12 Feb 15:21
· 114 commits to master since this release
v1.2.1

gdscript-docs-maker-banner

This release fixes 3 bugs in the program.

Changelog

Changes

  • Move the pip package's configuration to setup.cfg.
    • The setup now automatically finds packages and data.
    • This improves type checks and imports with mypy.

Bug fixes

  • The tool now outputs regular markdown code blocks instead of hugo shortcodes by default.
  • The Collector.gd script you can run from Godot's editor now rebuilds the language server cache so you don't need to restart Godot to rebuild the JSON class data.
  • Fixed an error in markdown conversion when the Godot Language Server generates empty classes in the generated JSON file.
    • If a class doesn't have a name, docs maker will now skip it.

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!