Create package for stub files, use sphinx-autoapi for processing.#74
Merged
jonnor merged 2 commits intoemlearn:masterfrom May 10, 2026
Merged
Create package for stub files, use sphinx-autoapi for processing.#74jonnor merged 2 commits intoemlearn:masterfrom
jonnor merged 2 commits intoemlearn:masterfrom
Conversation
This also requires renaming to .pyi Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Signed-off-by: Jos Verlinde <Jos_Verlinde@hotmail.com>
Contributor
|
Hi @Josverl and thank you for the contribution! I built the docs locally with this change, looks all good to me. |
Contributor
|
I will try setting up pushing the stubs package also to PyPI on releases. Maybe next week. Will ping you when it is there, then you can add it to the playground. |
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 PR adds a package for the stub files to allow them to be installed locally or from a github+ URI.
Also this would allow the stub package to be published to PyPI if desired.
As stub files are required to be
.pyifiles they need to be reamed.To allow the API documentation to be generated This also updated the documentation generation process to utilize
sphinx-autoapi.relevant configuration was migrated from sphinx-autodoc to -autoapi
The same document structure is retained.