Generate the API reference from src/outlines#1913
Merged
Merged
Conversation
|
📚 Documentation preview: https://dottxt-ai.github.io/outlines/pr-preview/pr-1913/ Preview updates automatically with each commit. |
RobinPicard
approved these changes
Jul 20, 2026
RobinPicard
left a comment
RobinPicard
left a comment
Contributor
There was a problem hiding this comment.
Nice, thanks for noticing the issue and opening a PR!
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
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.
Fixes #1912
The src layout migration (681009f) moved the package to
src/outlinesbutscripts/gen_ref_pages.pykept scanningroot/outlines, so the generated API reference has been empty in every build since — visible by comparing the released docs (latest/api_reference/models/, 200) with any recent PR preview (pr-preview/pr-1907/api_reference/models/, 404).One-line fix. Verified by building the docs locally: before,
api_reference/contained only the index and nav summary; after, all 12 module sections generate with rendered content. A side benefit is that the edit links on generated pages now point at the realsrc/outlines/...paths.Used an AI assistant to find and verify this; I reviewed and rebuilt the docs myself before submitting.