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

Set up workflow to build just the documentation. #989

Merged
merged 22 commits into from
Mar 14, 2025
Merged
Rate limit · GitHub

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

MarkCallow
Copy link
Collaborator

@MarkCallow MarkCallow commented Mar 4, 2025

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:

  • Make a separate pyktx.doc target instead of bolting the commands to build the documents on to the pyktx target.
  • Fix CMake 3.31 warnings in the pyktx CMakeLists.txt.
  • Update copyright, author and e-mail address in the pyktx package and documentation.
  • Add lists of files to ignore for in each workflow file.

@MarkCallow MarkCallow marked this pull request as draft March 4, 2025 10:40
@MarkCallow MarkCallow changed the title Set up workflow to build just the documents Set up workflow to build just the documentation. Mar 4, 2025
@MarkCallow
Copy link
Collaborator Author

@ShukantPal this PR adds a workflow to build just the KTX-Software documentation. For the Python binding I created a new pyktx.doc target separate from the pyktx target. But the custom command to build the documentation calls the pyktx buildscript.py which causes an attempt to link to libktx. I do not want to have to build libktx in this workflow. I tried commenting out the call to buildscripts.py but then I get errors like the following:

WARNING: autodoc: failed to import module 'ktx_hash_list' from module 'pyktx'; the following exception was raised:
No module named 'pyktx.native'

How can I build the documentation without building libktx?

@MarkCallow MarkCallow force-pushed the separate-docs-build branch from 3e0efd5 to f3e4657 Compare March 6, 2025 03:41
@MarkCallow MarkCallow force-pushed the separate-docs-build branch from 936a5cb to b4bb4c2 Compare March 14, 2025 02:41
@MarkCallow MarkCallow marked this pull request as ready for review March 14, 2025 11:50
@MarkCallow MarkCallow merged commit a45ffed into main Mar 14, 2025
20 checks passed
@MarkCallow MarkCallow deleted the separate-docs-build branch March 14, 2025 11:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rate limit · GitHub

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.

1 participant