website: add "API Reference" generation #406
Merged
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
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
…y DocFX Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
naskio
changed the title
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
Signed-off-by: Mehdi Nassim KHODJA <[email protected]>
naskio
changed the title
marcin-krystianc
approved these changes
Dec 9, 2024
This was referenced Oct 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This PR introduces an API Reference section to the website, generated using DocFX.
The section is conditionally injected into the site if it exists. The CI/CD pipeline has been updated to automatically build it when code changes are detected.
Preview
Key Changes
DocFX Integration:
docfx.json).Website Updates:
yarncommands to support the generation process.CI/CD Enhancements:
Miscellaneous:
yarn.lockto remove warnings.