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

GDExtension doc page broken. #76796

Closed
bend-n opened this issue May 6, 2023 · 12 comments · Fixed by #91126
Closed

GDExtension doc page broken. #76796

bend-n opened this issue May 6, 2023 · 12 comments · Fixed by #91126

Comments

@bend-n
Copy link
Contributor

bend-n commented May 6, 2023

Godot version

5319192 caused regression

System information

ArchLinux x11

Issue description

Opening docs (f1) and searching for desired GDExtension class will yield nothing, clicking on GDScript doc page with a typed fucntion that takes a GDExtension class (

func test(obj: VeryInterestingClass):
	pass

) Will take you to a empty doc page.

nodoc.mp4

gdext tracker

Steps to reproduce

I havent figured out how to use godot-cpp in 4.x, so the mrp is in rust.
To use:

  • cargo build -r (compiling godot-core will take a while, but its normal)
  • godot4 -e
  • Open docs
  • Search for StructThatDoesntShowUp
  • Open docs for Test
  • Click on the function type in test()

Minimal reproduction project

bug.zip

@bend-n
Copy link
Contributor Author

bend-n commented May 7, 2023

Does it not get the regression label?

@AThousandShips
Copy link
Member

AThousandShips commented May 7, 2023

GDExtension is strictly 4.x is it not? But can still technically be regression from 4.0.x of course

@bend-n
Copy link
Contributor Author

bend-n commented May 7, 2023

Its a regression that was introduced by 5319192.

@AThousandShips
Copy link
Member

I don't really see how that PR could have done anything to this documentation though, so very strange what actually caused it

@bend-n
Copy link
Contributor Author

bend-n commented May 7, 2023

Its probably some kind of thread misuse in the docgen?

@AThousandShips
Copy link
Member

I mean how it can affect only this part of documentation and not the general documentation, not sure

@AThousandShips
Copy link
Member

AThousandShips commented May 7, 2023

Does the issue persist if you change this line to false?

static bool doc_gen_use_threads = true;

Or if you straight up revert the PR

@bend-n
Copy link
Contributor Author

bend-n commented May 7, 2023

I bisected it so im pretty sure that the issue will persist (if i revert), will try later though.
But also, can you repro with the mrp yourself on master?

@AThousandShips
Copy link
Member

I'm not able to set up for gdextension at the moment on my platform, and haven't worked with gdextension previously

@dsnopek
Copy link
Contributor

dsnopek commented Oct 6, 2023

Possibly the same issue as #82817

@dkaste
Copy link
Contributor

dkaste commented Apr 6, 2024

v4.3.dev.custom_build [fe01776]

The docs load properly upon starting the editor, but the classes completely disappear from search once the GDExtension is reloaded. The docs pages stay open in the script editor, but are not updated. GDScript autocompletion for the relevant classes also stops working once the extension is reloaded.

Is this feature working properly for anyone? Is there any workaround?

Edit: Hot reloading documentation currently appears to be broken according to #84354 (review)

@dsnopek
Copy link
Contributor

dsnopek commented Apr 24, 2024

I'm able to reproduce this issue still (although, I think we may have fixed and re-introduced it at least once since this issue has been created - maybe even more than once :-)).

I just posted PR #91126 which fixes this in my testing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants