Skip to content

GDScript Docs Maker v1.5.0
Compare
Choose a tag to compare
@NathanLovato NathanLovato released this 04 Dec 00:25
· 42 commits to master since this release
v1.5.0
be72dbe

gdscript-docs-maker-banner

This release adds support for generating an index page with a table of contents, cross-references between pages, and more.

Changelog in v1.5.0

New Features

  • Added support for constants by @db0.

Bug fixes

  • Fixed descriptions eating whitespace and flattening nested lists. By @db0.

Changelog in v1.4.0

New Features

  • Added support for inner classes.
    • Known limitation: the program only supports one nesting level at the moment. This is in part
      because by writing them recursively, we would not have enough heading levels (web pages support
      6, we are already using 5). Also, we haven't found a project that used that GDScript feature
      yet, nesting sub-classes.
  • The shell program get_reference now supports command line flags.
  • You can specify directories of the Godot project to parse with get_reference and the
    -d/--directory option.

Improvements

  • There is now a -V/--version flag to print the version number.
  • Improved the shell program get_reference's code to better report errors and work by calling
    ./get_reference
  • Setter and getter functions now render as a bullet-point list with the member variable they belong to.

Changes

  • Headings now generate only with leading hashes # instead of being wrapped in hashes.
  • The syntax for tags and other special information now is like JSDoc: @tags - tag1, tag2, tag3.
    This differentiates special markup or metadata from the regular docstring. There is also a
    discussion to adopt markup like this
    in Godot.

Bug fixes

  • Fixed an error when using the --format hugo option.
  • Added the relative "../" to links to Fixed links leading to 404 pages.
  • Fixed table for setters and getters rendering as plain text with some markdown parsers.
  • Fixed function call error in ReferenceCollector.gd.

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!

Assets 2
Loading