Refine the API documentation to point to top-level package#618
Draft
LecrisUT wants to merge 5 commits into
Draft
Refine the API documentation to point to top-level package#618LecrisUT wants to merge 5 commits into
LecrisUT wants to merge 5 commits into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #618 +/- ##
========================================
Coverage 74.05% 74.05%
========================================
Files 27 27
Lines 8018 8018
Branches 1646 1643 -3
========================================
Hits 5938 5938
Misses 1603 1603
Partials 477 477
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
LecrisUT
commented
Nov 17, 2025
5e8e8c2 to
94238b5
Compare
atztogo
approved these changes
Nov 20, 2025
atztogo
reviewed
Dec 1, 2025
Needed to properly document typealiases
Signed-off-by: Cristian Le <git@lecris.dev>
Signed-off-by: Cristian Le <git@lecris.dev>
Collaborator
Author
|
Moving this to draft since we are blocked by myst-parser having to catch up with sphinx. Will ping when that is resolved. Edit: Hmm, actually I could split this PR into 2 to at least export the type-aliases |
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
3 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.
Seems like whatever issues we had with documenting the top-level package in sphinx is gone, so we can revisit the documentation and export of all pulbic objects.
Depends-on #619
Closes #617