Fix broken struct/class API pages and doc links#272
Open
cconlon wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot couldn't run its full agentic review because no GitHub Actions runner was available. Make sure your repository has a runner available to run Copilot's review, or add a copilot-setup-steps.yml file specifying one with the runs-on attribute. See the docs for more details.
This PR fixes broken API doc links by ensuring struct/class (“Classes”) pages are generated and by rewriting doxybook-generated Markdown links/anchors into forms that MkDocs correctly resolves.
Changes:
- Add
"classes"tofoldersToGeneratefor wolfMQTT, wolfTPM, and wolfHSM. - Update
html-prepsteps to copyClasses/docs into the site output and rewrite links/anchors for MkDocs compatibility. - Normalize wolfMQTT docs output to a
Classes/subfolder layout similar to the other projects.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| wolfTPM/doxybook.cfg | Enables generation of Classes/ struct/class pages. |
| wolfTPM/Makefile | Copies Classes/ into site output and rewrites Markdown links/anchors. |
| wolfSSL/Makefile | Rewrites leading-slash Markdown links so MkDocs resolves them. |
| wolfMQTT/doxybook.cfg | Enables generation of Classes/ struct/class pages. |
| wolfMQTT/Makefile | Copies Classes/ into site output and rewrites Markdown links/anchors (plus layout alignment). |
| wolfHSM/doxybook.cfg | Enables generation of Classes/ struct/class pages. |
| wolfHSM/Makefile | Copies Classes/ into site output and rewrites Markdown links/anchors. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR fixes broken links in the generated API documentation for wolfSSL, wolfMQTT, wolfTPM, and wolfHSM.
doxybook.cfgomitted"classes"fromfoldersToGenerate, so links tostruct/class pages 404'd.
and leading-slash
.mdpaths, which mkdocs doesn't rewrite to the built.htmlpages.Changes
"classes"tofoldersToGenerate(wolfMQTT, wolfTPM, wolfHSM).html-prep: copyClasses/pages into the site, strip leading slashes, and convert dash anchors to the underscore ids mkdocs generates.Classes/subfolder layout for consistency.Found when analyzing web server 404 logs.