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

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

Merged
merged 1 commit into from
May 7, 2024

Conversation

dsnopek
Copy link
Collaborator

@dsnopek dsnopek commented May 6, 2024

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

@dsnopek dsnopek added the enhancement New feature or request label May 6, 2024
@dsnopek dsnopek added this to the 3.0.0 milestone May 6, 2024
@dsnopek dsnopek requested a review from m4gr3d May 6, 2024 22:23
docs/conf.py Outdated Show resolved Hide resolved
@m4gr3d
Copy link
Collaborator

m4gr3d commented May 7, 2024

Looks great!

@m4gr3d m4gr3d merged commit 5331555 into GodotVR:master May 7, 2024
7 checks passed
@dsnopek
Copy link
Collaborator Author

dsnopek commented May 7, 2024

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/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants