this post was submitted on 24 Oct 2024
21 points (100.0% liked)

Godot

5909 readers
1 users here now

Welcome to the programming.dev Godot community!

This is a place where you can discuss about anything relating to the Godot game engine. Feel free to ask questions, post tutorials, show off your godot game, etc.

Make sure to follow the Godot CoC while chatting

We have a matrix room that can be used for chatting with other members of the community here

Links

Other Communities

Rules

We have a four strike system in this community where you get warned the first time you break a rule, then given a week ban, then given a year ban, then a permanent ban. Certain actions may bypass this and go straight to permanent ban if severe enough and done with malicious intent

Wormhole

[email protected]

Credits

founded 1 year ago
MODERATORS
 

I want to integrate the online documentation a bit nicer into the editor itself. Is it somehow possible to query that page and get the contents of the searched-for entries?

Best case would be, if we can get the queried site content as JSON, that'd be nice, but very unlikely I think.

top 3 comments
sorted by: hot top controversial new old
[–] [email protected] 15 points 1 month ago

https://github.com/godotengine/godot-docs

This is the source for Godot's documentation. You could clone the repo (in reST format) or download one of the releases (in HTML format) offline, so you wouldn't even need to query anything online.

[–] [email protected] 8 points 1 month ago* (last edited 1 month ago) (1 children)

The documentation is available on github which might be easier to deal with than scraping the website?

https://github.com/godotengine/godot-docs

Out of interest, what additions would you want to include? The editor has documentation built in as far as I understand

https://docs.godotengine.org/en/stable/getting_started/introduction/first_look_at_the_editor.html#integrated-class-reference

[–] [email protected] -2 points 1 month ago* (last edited 1 month ago)

It is true that the editor has the build in class reference. I have already tried to retrieve the text from when that pops up, and I have managed to do that partly, however it doesn't segment anything. The reason why I want a cool format like JSON or maybe YAML is that I can parse it and separate it into variables, which can then be nicely display in smaller UI elements.

::: spoiler secret reason why I want to segment the docs (CW: overhyped topic) Okay, don't tell this to anyone, because many people don't want to hear anything about this topic, which is reasonable: it's abnoxious and overhyped.

whispering: ~The~ ~reason~ ~I~ ~want~ ~to~ ~segment~ ~the~ ~docs~ ~is~ ~because~ ~I~ ~want~ ~to~ ~embed~ ~them~ ~and~ ~use~ ~them~ ~as~ ~structured~ ~input~ ~for~ ~a~ ~locally~ ~running~ ~LLM~ ~for~ ~better~ ~context.~

shocked crowd sound

I already made two posts about this on here: This one and this one. :::