GDScript Docs Maker v1.3.0

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

Changelog

Features

• Create an index page with a table of contents. To do so, use the new
  command-line option --make-index. This generates an extra index.md file.
• You can now link between classes, including to specific methods and
  properties:
  • Write [ClassName], [ClassName.symbol], or [symbol_in_this_class] and
    docs maker will replace it with a link to the corresponding page and
    heading.
• Add support for the class categorymetadata: this allows you to group classes by categories. Add a line with# category: My Category` in your
  class's docstring to register a category for it.
• Classes now show all ancestors they extend, and the extends list links to
  the reference of parent classes.
• Store and write key project information: name, description, and human-readable
  version string.
  • We get them from the Application Settings in your Godot project.
  • For the project version, in 3.2.0, you need to add it yourself as
    `application/config/version. It must be with the form "1.0.0". Future or
    more recent Godot versions should have this defined by default. Upon
    exporting your game, Godot should also use this version number.

Improvements

• The Windows generate_reference.bat command-line script now supports
  command-line flags and arguments. The script also now checks for and prevents
  common errors.
• Remove extends line if the class doesn't extend any type.
• Remove properties summary and methods summary if the class respectively
  doesn't have public properties or methods.

Changes

• Changed the default export directory to "export", as we use "dist" to build
  the program's pip package itself.

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!