Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for built-in Godot documentation #8

Open
limbonaut opened this issue Oct 29, 2024 · 0 comments
Open

Add support for built-in Godot documentation #8

limbonaut opened this issue Oct 29, 2024 · 0 comments

Comments

@limbonaut
Copy link
Collaborator

Godot has a built-in documentation system that does not require online access. Godot game developers usually expect to find some useful information about the public API in there.
Image

Documentation tool is part of Godot, e.g. godot --doctool. It generates XML files for the public API exposed to ClassDB, and also updates those XML files on subsequent runs, but it only deals with the document structure. The descriptions need to be added manually to those XML files. It preserves the added content on subsequent runs. There is also a tool to export sphinx-based RST-formatted class documentation.

@limbonaut limbonaut added the enhancement New feature or request label Oct 29, 2024
@limbonaut limbonaut moved this to Todo in GDX Oct 29, 2024
@limbonaut limbonaut removed the enhancement New feature or request label Nov 14, 2024
@limbonaut limbonaut moved this from Todo to Backlog in GDX Dec 20, 2024
@limbonaut limbonaut removed the status in GDX Dec 20, 2024
@limbonaut limbonaut moved this to Backlog in GDX Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

1 participant