GodotVR / godot_openxr_vendors

Godot 4 wrapper for OpenXR vendors loaders and extensions
MIT License
82 stars 17 forks source link

Implement the structure for adding API and hand-written documentation #138

Closed dsnopek closed 2 months ago

dsnopek commented 2 months ago

This PR attempts to setup the structure to allow us to add documentation!

For in-editor API documentation, this PR depends on:

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:

Selection_154

Selection_153

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 :-)

m4gr3d commented 2 months ago

Looks great!

dsnopek commented 2 months ago

Looks like the GitHub actions worked! The docs (such as they are) have been pushed to GitHub pages:

https://godotvr.github.io/godot_openxr_vendors/