Allow creating the documentation-only classes#230
Merged
Conversation
Downstream code might create these at the top level, so erroring in the `__init__` means that is it not even possible to import the package for documentation
Contributor
|
yes sure, checking |
Contributor
|
seems ok! i did this in the pyproject.toml: |
Member
Author
|
Ok, thanks for checking! I'll put this in another release then! |
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
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.
Downstream code might create these at the top level, so erroring in the
__init__means that is it not even possible to import the package for documentation.xref metatensor/metatrain#1144
@sofiia-chorna can you try building the docs with this PR?
Contributor (creator of pull-request) checklist
Tests updated (for new features and bugfixes)?Issue referenced (for PRs that solve an issue)?Reviewer checklist
CHANGELOG updated with public API or any other important changes?