Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[autodoc] add support for python_display_short_literal #12003

Open
wants to merge 37 commits into
base: master
Choose a base branch
from

Conversation

picnixz
Copy link
Member

@picnixz picnixz commented Feb 24, 2024

Closes #11995.

@user27182 Could you check if this patch works? I added a test but since I refactored autodoc for that, I want to be sure that I didn't forget some places (and this can essentially be checked with large projects).

I won't merge this one until I get approval from another maintainer since it's a fairly sensitive component.

@picnixz
Copy link
Member Author

picnixz commented Feb 29, 2024

So now, we have another flaky test on windows 😆 It's entirely caused by the network so I don't have a good way to make it "safe and easy"

@jayaddison
Copy link
Contributor

So now, we have another flaky test on windows 😆 It's entirely caused by the network so I don't have a good way to make it "safe and easy"

Sorry that I didn't notice this earlier (I disabled my sphinx notification subscriptions a while ago after becoming overwhelmed) - it is now reported at #12038.

@jayaddison
Copy link
Contributor

About the Python3.13 test failures:

23 Mar 2024, 16:25
@launchpadstatus@ubuntu.social
Launchpad is down due to unexpected hardware issues and our SREs are working to fix it.

@jayaddison
Copy link
Contributor

About the Python3.13 test failures:

23 Mar 2024, 16:25
@launchpadstatus@ubuntu.social
Launchpad is down due to unexpected hardware issues and our SREs are working to fix it.

The PPA functionality of Launchpad appears to be restored; I'm not yet certain about the status of their other services.

sphinx/util/inspect.py Outdated Show resolved Hide resolved
sphinx/util/typing.py Outdated Show resolved Hide resolved
sphinx/util/typing.py Outdated Show resolved Hide resolved
Co-authored-by: James Addison <55152140+jayaddison@users.noreply.github.com>
sphinx/util/typing.py Outdated Show resolved Hide resolved
@jayaddison
Copy link
Contributor

The output from the latest commit at 032bf8c appears to solve the problem in the minimal-repro case:

image

@jayaddison
Copy link
Contributor

(oops; I'm not claiming that that commit fixed it -- it's the one the screenshot was taken from though)

sphinx/util/typing.py Outdated Show resolved Hide resolved
@picnixz
Copy link
Member Author

picnixz commented Mar 23, 2024

I'll review a last time tomorrow when I'm on Linux before merging it.

@picnixz picnixz removed the request for review from AA-Turner March 23, 2024 23:49
@picnixz
Copy link
Member Author

picnixz commented Apr 10, 2024

I'll wait for #12256 and #12257 and #12258 to be merged since it's easier for me if I don't have to resolve conflicts with those branches.

Waiting for 8.x or to make it in 7.3.x.

@picnixz picnixz mentioned this pull request Apr 10, 2024
@picnixz picnixz marked this pull request as draft April 15, 2024 07:52
@picnixz
Copy link
Member Author

picnixz commented Apr 24, 2024

Oh, now that the PRs for refactoring typing are merged, I can fix that one back !

…display-short-literal

# Conflicts:
#	CHANGES.rst
#	sphinx/util/inspect.py
#	sphinx/util/typing.py
@picnixz picnixz marked this pull request as ready for review April 24, 2024 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Config option python_display_short_literal_types not working
2 participants