fix: style tweak for auto api #2057
Merged
Conversation
This file contains 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
|
Deploy preview (what happened to the automatic comment?): https://deploy-preview-2057--sphinxawesome-theme.netlify.app/ |
Repository owner
deleted a comment
Nov 8, 2024
|
LGTM thanks a lot for your promptness! |
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.
Fix display issues for type hints in API documentation with
sphinx-autoapi.To be able to better check this, this PR also adds a small mock Python module,
with a demo page for documenting it.
Styling is not 100% perfect, as the page now includes double lines (one for the heading 'Module contents' and one for the function signature). But still better than before.
@vict0rsch I hope it's ok that I took your function from issue #2056 and put it as an example in these docs.
Fixes #2056.