Skip to content

Updated to makefile for new wolfHSM/docs dir#235

Merged
bigbrett merged 6 commits into
masterfrom
wolfHSM-doc-fixes
Jan 2, 2026
Merged

Updated to makefile for new wolfHSM/docs dir#235
bigbrett merged 6 commits into
masterfrom
wolfHSM-doc-fixes

Conversation

@jackctj117

@jackctj117 jackctj117 commented Dec 1, 2025

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Contributor Author

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

@bigbrett bigbrett left a comment

Copy link
Copy Markdown
Contributor

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
Copy Markdown
Contributor Author

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

@bigbrett

bigbrett commented Dec 2, 2025

Copy link
Copy Markdown
Contributor

@jackctj117 its merged

Comment thread wolfHSM/Makefile Outdated
@bigbrett

Copy link
Copy Markdown
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
Copy Markdown
Contributor Author

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

@bigbrett
bigbrett dismissed their stale review January 2, 2026 19:48

addressed

@bigbrett
bigbrett merged commit 6e3fbd8 into master Jan 2, 2026
4 checks passed
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.

2 participants