Forums Game Development Thread


Godot Markdown Docs Generator

Dylan

Admin

Level 34
Joined 9/14/16

Posted Apr 3, 2024, 4:43pm CST OP
Edited Apr 3, 2024, 4:47pm CST

An example of generate docs being displayed on GitHub

I made a short script to generate markdown formatted documentation for an entire Godot project. Needed it for the Ezcha Network plugin and thought it could be useful for other Godot developers! It supports both Godot 3 and 4, links all types including custom classes, has no dependencies and uses the built-in comment doc format. I tried to replicate the layout of the official docs the best I could.

https://gist.github.com/Ezcha/164f3aaf0ac96471bdf0d33fb57b6e58

It should support pretty much everything except for the few exceptions listed below.

  • Does not support inline doc comments
  • Custom enum links break
  • Multi-line dictionary/array default values do not display properly

Replies

Join the Ezcha Network!

You must be logged in to reply.

Login or register

This is an advertisement. Get Ezcha Elite to remove ads.