Merged
Conversation
rwb27
changed the title
julianstirling
approved these changes
Apr 2, 2026
Contributor
julianstirling
left a comment
julianstirling
left a comment
There was a problem hiding this comment.
My only worry I think here is how we make sure the full signatures in the public API file are always correct in full? A checkbox helps, but it feels like a bit of stop-gap?
…the rest of the documentation.
This builds the docs in CI, and then checks the `lt` symbols against our top-level `__all__`. Hopefully, doing so will stop things getting out of date.
FEATURE_FLAGS is an object not a class, which confuses my code that deduplicates re-exported symbols. I have added FEATURE_FLAGS as a special case.
This adds in the remaining symbols and renames "quick reference" to "public API". Renaming the full API docs required me to pull in templates for autoapi. This might go away in the future if we transition fully to autodoc. I've had to fix a couple of references too.
Collaborator
Author
|
I've made an issue to set up a merge checklist. I think there might be some scope for more automation here too, but it will require a bit of thought to get right. |
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.
This is an attempt to improve the user-facing documentation. Rather than the previous somewhat awkward approach of making the various symbols that are promoted to
lt.*disappear from the modules they're actually defined in, then showing them at the top level, this PR creates a new "quick reference API documentation" page with summaries of the key classes/functions.These summary definitions may be referenced with
lt.Thingorlt.property. This serves two purposes:@lt.actionfor the decorator).I think the new quick reference page is going to be quite useful, but I think it's worth taking suggestions on this structure...