Publish stable API documentation with Sourcey and GitHub Pages - #403
Open
RYDE-PLAY wants to merge 1 commit into
Open
Publish stable API documentation with Sourcey and GitHub Pages#403RYDE-PLAY wants to merge 1 commit into
RYDE-PLAY wants to merge 1 commit into
Conversation
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.
Hi, I put together a complete implementation for #395.
This publishes documentation for the current stable
masterbranch while keeping the existing QCBOR v2 alpha documentation clearly linked and separate.What this adds:
masterThe group additions are documentation comments around the existing public headers; they do not change compiled behavior. Private implementation symbols and
qcbor_private.hare excluded from the generated API.Validation performed:
pnpm install --frozen-lockfilepnpm run docsmake warn./qcbortest— 76 tests passed, 0 failedgit diff --checkThe Doxygen step still prints the existing undocumented-symbol and obsolete-option warnings from the source and Doxyfile, but completes successfully.
One repository setting is needed after merge: under Settings → Pages → Build and deployment, select GitHub Actions as the source. After that, the included workflow will publish and update the site automatically.
I would be happy to adjust the organization, wording, colors, or workflow split to better match the project's preferences.
Closes #395.