Godot Autogen Docs

Godot addon that automatically turns your code comments into markdown, for use in documentation.

About

Usage

$ just godot --editor --headless --quit --script addons/godot-autogen-docs/cli.gd help

Usage:
        godot --editor --headless --quit --script res://addons/godot-autogen-docs/cli.gd <command> [<options> ...]

Commands:
        help                    Display this text
        markdown                Export documentation to markdown
        readthedocs             Export documentation to markdown compatible with the readthedocs theme

Options:
        -ddir                   Comma delimited list of directories to collect files from
        -doutdir                A directory for saving documentation files

Contributing

We welcome community contributions to this project.

Please read our Contributor Guide for more information on how to get started.