Implement the structure for adding API and hand-written documentation #138
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR attempts to setup the structure to allow us to add documentation!
For in-editor API documentation, this PR depends on:
--gdextension-docs
with--doctool
godotengine/godot#91518godot --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 :-)