Skip to content

Conversation

@jackctj117
Copy link
Contributor

@jackctj117 jackctj117 commented Dec 1, 2025

This pull request updates the wolfHSM/Makefile to improve documentation build robustness and support a transition to a new documentation source directory. The changes ensure the correct documentation source is used, handle symlinked repositories for local testing, and guarantee that the external wolfhsm repo is cloned before documentation is built. Overrides to setup targets are introduced to inject these dependencies.

@jackctj117 jackctj117 self-assigned this Dec 1, 2025
@jackctj117 jackctj117 changed the title Wolf hsm doc fixes Updated to makefile for new wolfHSM/docs dir Dec 1, 2025
@jackctj117
Copy link
Contributor Author

Need to wait for wolfSSL/wolfHSM#256 to be merged

Copy link
Contributor

@bigbrett bigbrett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jackctj117 This PR should also remove this documentation source from the wolfHSM directory, no? We don't want two copies of the documentation source floating around.

Also ensure that the documentation builds and renders properly both locally and in our nightly job using the relocated source before this gets merged

@jackctj117
Copy link
Contributor Author

Yes was waiting for the other PR to be merged before removing those directories so the nightly wouldn't fail

@bigbrett
Copy link
Contributor

bigbrett commented Dec 2, 2025

@jackctj117 its merged

@bigbrett
Copy link
Contributor

@jackctj117 thanks. Have you verified that the docs render properly? Specifically the client API doxygen as part of the manual? Just want a set of eyes on it before this merges and potentially breaks our customer-facing docs

@jackctj117
Copy link
Contributor Author

@bigbrett confirmed this works locally and produces the client API doxygen as part of the manual.

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.

3 participants