-
Notifications
You must be signed in to change notification settings - Fork 84
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
Built in documentation and tutorials #90
Comments
There are 2 ways to do this.
The second one is easier but needs more maintenance. Most project would go with the first one. HTML RendererI can't find one in Godot itself. But I found Godot Firebase. The Database needs to be moved there for this but it requires internet for the first time. I found another solution which has the same problem as above, it is Google Spreadsheet. Hand Convert ItIt is the most possible method. Godot and Unreal Engine partially do this by having an Offline Help which is less helpful than the Online Docs. |
I ended up using the easiest approach. There's a new panel you can toggle on and off with all the information you need for a specific node. This has the benefit of always having the documentation ready without having to open a new window and look for a specific page, but the drawback is that I can't extract this to generate the HTML automatically for an online documentation. This could be solved if I didn't hard-code the documentation in the node script itself, but I haven't looked into it yet. What I could do is to write the nodes' documentation in JSON files. That's easy and there's already a JSON parser in Godot. Then I assume it would be easy to parse these from an external app to generate the online docs automatically. |
A potential solution is also the usage of Sphinx, Sphinx is the official documentation tool for Python which could make it a potential good fit for GDScript, the advantages of Sphinx are numerous
What you are waiting for , buy NOW your own copy of Sphinx for only 300 euros and get one free !!! Hurry UP While the Stonk LASTS !!!! No I am joking , Sphinx is free and very much open source ---> https://www.sphinx-doc.org/en/master/ |
For the upcoming standalone version, the documentation should be available from inside the software without having to look it up online.
The text was updated successfully, but these errors were encountered: