-
Notifications
You must be signed in to change notification settings - Fork 246
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
Set up workflow to build just the documentation. #989
Access has been restricted
You have triggered a rate limit.
Please wait a few minutes before you try again;
in some cases this may take up to an hour.
Conversation
@ShukantPal this PR adds a workflow to build just the KTX-Software documentation. For the Python binding I created a new
How can I build the documentation without building libktx? |
3e0efd5
to
f3e4657
Compare
They are needed for inclusion in install packages.
Add comments and COMMENTs for future spelunkers. UPdate copyright message for documentation.
Document full plan for this workflow and why it is currently limited.
936a5cb
to
b4bb4c2
Compare
The plan is to use this workflow to build the docs for PRs and pushes to main. Due to the tight deadline for 4.4, there is no time to update the per-platform software build workflows to only build the docs only when building for a release so only the Ubuntu build is enabled now. This is used to deploy the docs to GitHub Pages. For now this only happens for a release tag. Once a location is set-up the plan is to deploy docs for release tags to somewhere on khronos.org and deploy docs to GitHub Pages on any pushes to main.
The following other changes are incorporated in this PR:
pyktx.doc
target instead of bolting the commands to build the documents on to thepyktx
target.