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

Documentation update - BTSubTree #96

Merged
merged 4 commits into from
Apr 22, 2024
Merged

Conversation

onze
Copy link
Contributor

@onze onze commented Apr 22, 2024

Added a note about updating subtree at runtime.

Added a note about updating `subtree` at runtime.
@limbonaut
Copy link
Owner

The content is good, but the files under doc/source/classes/ are auto-generated using godot's make-rst.py script. You need to change related XML-file in doc_classes/ instead.

@limbonaut limbonaut added the documentation Improvements or additions to documentation label Apr 22, 2024
@onze
Copy link
Contributor Author

onze commented Apr 22, 2024

Right. So, it turns out that per the class xsd, links don't seem to be allowed, and I couldn't hardcode the rst in there either, so here it is plain 🤮
Feel free to suggest a better alternative.

doc_classes/BTSubtree.xml Outdated Show resolved Hide resolved
@limbonaut
Copy link
Owner

limbonaut commented Apr 22, 2024

This is how I generate the rst part:

#!/bin/sh
./doc/tools/make_rst.py --output /tmp/rst doc/tools doc/classes/@GlobalScope.xml modules/limboai/doc_classes
rsync /tmp/rst/class_* modules/limboai/doc/source/classes/ --exclude class_@globalscope.rst

You'd need godot sources (4.2 branch) with limboai sources deployed in modules/limboai.
But you don't need to bother with the rst part - I always update rst before release.

@onze onze requested a review from limbonaut April 22, 2024 17:53
@limbonaut
Copy link
Owner

Thanks!

@limbonaut limbonaut merged commit 2bfedec into limbonaut:master Apr 22, 2024
18 checks passed
@onze onze deleted the patch-1 branch April 22, 2024 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants