This allows godot-cpp to send those XML docs to the Godot editor when loaded
However, this also includes a Sphinx setup based on godot-docs, which can convert that XML into RST for online API documentation, as well as allowing us to add hand-written RST for tutorials and other more wordy explanations.
Here's some screenshots of the HTML docs:
There are GitHub actions included that will automatically build these docs and push them to GitHub pages, when changes are pushed to the master branch.
You can see the GitHub pages on my fork, which I used to test that the GitHub actions were working.
This PR doesn't include much in the way of actual documentation, it's meant to setup the structure, and then we can actually write some docs in follow-up PRs. However, for testing, I added API documentation for OpenXRFbRenderModel (link to GitHub pages on my fork).
The docs/README.md explains how you can build the docs locally.
Note: It appears we missed the argument names when binding some methods, so I also added those in this PR, so that it would stop complaining about them being missing, when generating the docs :-)
This PR attempts to setup the structure to allow us to add documentation!
For in-editor API documentation, this PR depends on:
godot --doctool --gdextension-docs
to update XML documentation for GDExtensionsHowever, this also includes a Sphinx setup based on godot-docs, which can convert that XML into RST for online API documentation, as well as allowing us to add hand-written RST for tutorials and other more wordy explanations.
Here's some screenshots of the HTML docs:
There are GitHub actions included that will automatically build these docs and push them to GitHub pages, when changes are pushed to the
master
branch.You can see the GitHub pages on my fork, which I used to test that the GitHub actions were working.
This PR doesn't include much in the way of actual documentation, it's meant to setup the structure, and then we can actually write some docs in follow-up PRs. However, for testing, I added API documentation for OpenXRFbRenderModel (link to GitHub pages on my fork).
The
docs/README.md
explains how you can build the docs locally.Note: It appears we missed the argument names when binding some methods, so I also added those in this PR, so that it would stop complaining about them being missing, when generating the docs :-)