Skip to content

DOC: use the sphinx-panels extension for cards instead of raw html #34065

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

Merged

Conversation

jorisvandenbossche
Copy link
Member

This is an alternative for #32065, using the https://sphinx-panels.readthedocs.io/en/latest/ extension (which was created inspired on how we are using this in our docs, but then nicely packaged in a sphinx extension to avoid the use of raw html).

@jreback
Copy link
Contributor

jreback commented Jun 14, 2020

@jorisvandenbossche still relevant?

@jbrockmendel
Copy link
Member

@jorisvandenbossche gentle ping

@github-actions
Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Oct 15, 2020
@jreback
Copy link
Contributor

jreback commented Nov 26, 2020

@jorisvandenbossche ?

@jreback
Copy link
Contributor

jreback commented Feb 11, 2021

@jorisvandenbossche pls update or close

@jorisvandenbossche jorisvandenbossche marked this pull request as ready for review March 28, 2021 09:36
@jorisvandenbossche
Copy link
Member Author

@dsaxton I updated this PR to also convert the front page cards to use sphinx-panels, and with some custom styling to keep the same look and feel, I get this:

image

The "buttons" are using the default darker grey and sharper corners from sphinx-panels, but if we prefer the lighter gray / more rounded corners as it is now, that's easy to change as well.

For reference, screenshot of the current https://pandas.pydata.org/docs/dev/:

image

@dsaxton
Copy link
Member

dsaxton commented Mar 28, 2021

@dsaxton I updated this PR to also convert the front page cards to use sphinx-panels, and with some custom styling to keep the same look and feel, I get this:

Nice. The stronger contrast with the dark button color does make them a bit more readable. This is subjective though so I'm curious how others feel.

@dsaxton dsaxton removed the Stale label Mar 28, 2021
@jreback
Copy link
Contributor

jreback commented Mar 29, 2021

+1 on the look and not using raw html

</p>
</div>
<div class="card-footer text-muted">
conda install pandas
Copy link

Choose a reason for hiding this comment

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

This should be

Suggested change
conda install pandas
pip install pandas

Copy link
Member Author

Choose a reason for hiding this comment

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

Whoops, copy/paste error ;) Thanks for the catch!

@jreback jreback added this to the 1.3 milestone Apr 8, 2021
@jorisvandenbossche jorisvandenbossche merged commit b5622c6 into pandas-dev:master Apr 9, 2021
@jorisvandenbossche jorisvandenbossche deleted the sphinx-panels branch April 9, 2021 06:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants