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

DOC: Use container directives instead of raw html for the doc "cards" #32065

Closed
wants to merge 61 commits into from

Conversation

stijnvanhoey
Copy link
Contributor

  • closes #xxxx
  • tests added / passed
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

The PR is a follow up of #31156 and #31148 translating the raw html to docutils/sphinx directives, making it more readable.

Furthermore, it fixes the redundant css in pandas.css versus getting_started.css by removing the install-card class and merging it with the existing intro-card class.

Note: The setup required an adjustment to the theme to overcome the usage of the container class by both docutils and bootstrap.

@simonjayhawkins
Copy link
Member

@stijnvanhoey can you merge master to get the ci green.

@WillAyd
Copy link
Member

WillAyd commented Feb 20, 2020

I think looks good but @jorisvandenbossche

Is this directive provided by sphinx or someone else?

@jorisvandenbossche
Copy link
Member

Yes, it's even from base docutils / restructuredtext.

But, this still depends on a change in the sphinx theme to support the way it is styled (a conflict in a css class needs to be solved); so this needs to wait on that (pydata/pydata-sphinx-theme#92)

@jorisvandenbossche jorisvandenbossche changed the title Directive DOC: Use container directives instead of raw html for the doc "cards" Feb 20, 2020
@datapythonista
Copy link
Member

Looks like both this PR and the one is depending on have conflicts. Are we still moving forward with this?

@jorisvandenbossche
Copy link
Member

Yes, I think we still want to forward with this. The linked PR mainly conflicts due to the rename, will try to move forward that PR.

@chrisjsewell
Copy link

chrisjsewell commented May 7, 2020

Hey guys, just an FYI, that I took your good idea here and turned it into an extension: https://github.com/executablebooks/sphinx-panels

(in this extension I also provide a "fix" for pydata/pydata-sphinx-theme#92)

@jorisvandenbossche
Copy link
Member

First try to convert some of the cards to use sphinx-panels -> #34065 (still needs to be further updated, though). So let's close this PR in favor of that one.

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.

6 participants