Keep the Fern API reference in sync with the sources - #2547
Open
imotov wants to merge 2 commits into
Open
Conversation
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
imotov
added
bug
Contributor
Author
|
/ok to test 76f998d |
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
1 participant
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.
The generated API reference under
fern/pages/*_api/had drifted roughly five weeks behind the code, becausefern/scripts/generate_api_reference.pyis rarely run and CI can't detect it -fern/build_docs.shregenerates before runningfern check, so it validates freshly-generated output rather than what's committed.This PR consists of two commits:
7e0b8ee97Add fern docs generation to pre-commit - adds afern-api-referencehook that regenerates the pages and fails if they differ from what's committed, so drift can't accumulate again (CI picks this up for free viaci/check_style.sh). Also fixes four generator bugs it surfaced: the nav losingpages/api_reference.md,"Neighbors IVF RaBitQ"being rewritten to"Rabitq",privatemembers appearing under "Public Members", and Java nav entries reading"Com Nvidia cuVS Cuvsdevicematrix"instead ofCuVSDeviceMatrix. Adds--quietso the hook's output stays readable.76f998d77Update all stale documents - this commit is huge but it contains only the resulting regeneration.Fixes #2546