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

Add mechanism for comparison of setup.py and its equivalent setup.cfg #2584

Merged
merged 4 commits into from Mar 5, 2021

Conversation

amy-lei
Copy link
Contributor

@amy-lei amy-lei commented Mar 1, 2021

Summary of changes

Closes #1699

Add the sphinx-inline-tabs extension to allow tabbed containers for comparing setup.py and setup.cfg. The tabs works even when JS is disabled. This PR also replaces instances of adjacent code-blocks with the new extension.

However, I wasn't sure if there was an issue with the default styling. It currently looks like this:
image
The only thing that stood out and possibly needed overriding was the accent color of the tabs.

Pull Request Checklist

docs/conf.py Outdated Show resolved Hide resolved
Copy link
Member

@jaraco jaraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is beautiful. I honestly did not expect this change to be possible, but the solution you found and implemented is simple and elegant. Thoroughly impressed and grateful.

@jaraco jaraco merged commit 23ee037 into pypa:main Mar 5, 2021
This was referenced Mar 8, 2021
This was referenced Mar 15, 2021
@webknjaz
Copy link
Member

Merging this PR has broken the RTD setup 3 weeks ago. Since then, all the builds are failing: #2614.
I think we should enable the PR RTD builds toggle (#2469) to notice such problems early.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add mechanism for side-by-side comparison of setup.py and its equivalent setup.cfg
3 participants