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 and expose a method for getting a list of script documentation in the Script class #64541

Closed
wants to merge 1 commit into from

Conversation

Xwdit
Copy link
Contributor

@Xwdit Xwdit commented Aug 17, 2022

Replace #62928 since I messed something up in the original PR.

Part modified from #39849 by @ThakeeNathees

This allows users to access script documentation through scripts when tools=yes, making it easy to export script documentation to xml/json/bbcode/markdown etc, or create any tool based on it.

Partial implementation godotengine/godot-proposals#177

This should allow more freedom than exporting several preset document formats through the editor UI, allowing community to easily create various addons to export documents in different formats.

For example, here is a Json/Markdown documentation generator based on this PR: Script Documentation Generator.zip

@akien-mga @YuriSizov

@Xwdit
Copy link
Contributor Author

Xwdit commented Aug 17, 2022

Will this be moved to the 4.x milestone even though the original PR was submitted before the feature freeze?

doc/classes/Script.xml Outdated Show resolved Hide resolved
@Xwdit Xwdit force-pushed the script_doc_method branch 2 times, most recently from 6ed1dd3 to 2b0c457 Compare August 17, 2022 17:13
@YuriSizov
Copy link
Contributor

YuriSizov commented Aug 17, 2022

Will this be moved to the 4.x milestone even though the original PR was submitted before the feature freeze?

4.x just means it can be merged in any 4.x version. If this is approved soon, it can be included in 4.0. But as it stands, it doesn't block 4.0, I don't think.

@Xwdit Xwdit force-pushed the script_doc_method branch from 2b0c457 to be0b67a Compare August 18, 2022 08:48
Comment on lines +53 to +55
"name": "",
"inherits": "",
"brief_description": "",
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of enshrining this structure in a (for us) hard to find place we need to keep updated. It also tends to change, so we'd need to maintain it. Maybe we could link to doc_data.h?

@Xwdit Xwdit force-pushed the script_doc_method branch from 8335efe to 1f06cab Compare January 10, 2023 18:03
@YuriSizov
Copy link
Contributor

I guess #76490 supersedes this as a more practical solution. It doesn't expose any scripting API, but instead if generates XML in the same format that the engine uses. Thanks for your contribution nevertheless!

@YuriSizov YuriSizov closed this May 15, 2023
@YuriSizov YuriSizov removed this from the 4.x milestone Dec 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants