Sphinx: Make .pyi files available
#699
Open
Conversation
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
ax3l
added
component: documentation
ax3l
force-pushed
the
fix-sphinx-pyi-auto
branch
from
3b9bff5 to
843f663
Compare
ax3l
force-pushed
the
fix-sphinx-pyi-auto
branch
2 times, most recently
from
5ce181a to
5ed3e28
Compare
ax3l
force-pushed
the
fix-sphinx-pyi-auto
branch
from
5ed3e28 to
567d692
Compare
5 tasks
ax3l
force-pushed
the
fix-sphinx-pyi-auto
branch
2 times, most recently
from
4732cc3 to
e15ff19
Compare
Same config as in pyAMReX to use `.pyi` interface files in Sphinx docs.
Sorting issue in pybind11-stubgen can be resolved by: - moving the base class into a separate file/import - renaming the base class to something alphabetically earlier - removing the base class. Since the class that shows the issue is somewhat unnecessary, we remove it.
ax3l
force-pushed
the
fix-sphinx-pyi-auto
branch
from
e15ff19 to
90da70e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Same config as in pyAMReX to use
.pyiinterface files in Sphinx docs.autoclassandautofunctionworkFollow-up to #697 (comment)