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

Draft
wants to merge 18 commits into
base: main
Choose a base branch
from

Conversation

MarkCallow
Copy link
Collaborator

@MarkCallow MarkCallow commented Mar 4, 2025

Make a separate pyktx.doc target for instead of bolting the commands to build the documents on to the pyktx target.

Fix CMake 3.31 warnings in the pyktx CMakeLists.txt.

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
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.

1 participant