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

Fix GDExtension documentation disappearing after hot-reload #91126

Merged

Conversation

dsnopek
Copy link
Contributor

@dsnopek dsnopek commented Apr 24, 2024

Fixes #76796

Currently, unless a GDExtension provides its own documentation by submitting XML data, its classes will be removed from the editors docs on a successful hot-reload.

This PR fixes that, by re-generating the docs after any extensions have been hot-reloaded.

Works in my testing, both with GDExtensions that provide XML docs data, and those that don't!

@dsnopek dsnopek added bug topic:editor topic:gdextension cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release labels Apr 24, 2024
@dsnopek dsnopek added this to the 4.3 milestone Apr 24, 2024
@dsnopek dsnopek requested review from a team April 24, 2024 21:45
@dsnopek dsnopek force-pushed the fix-gdextension-docs-on-reload branch from 3d429d5 to 52324eb Compare April 25, 2024 12:25
Copy link
Contributor

@Riteo Riteo left a comment

Choose a reason for hiding this comment

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

Looks simple and straight-forward :D

@akien-mga akien-mga merged commit d015a74 into godotengine:master Apr 26, 2024
16 checks passed
@akien-mga
Copy link
Member

Thanks!

@dsnopek dsnopek deleted the fix-gdextension-docs-on-reload branch July 22, 2024 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug cherrypick:4.2 Considered for cherry-picking into a future 4.2.x release topic:editor topic:gdextension
Projects
None yet
Development

Successfully merging this pull request may close these issues.

GDExtension doc page broken.
3 participants