Skip to content

DOC: migrate from sphinx-panels to sphinx-design #46227

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 12 commits into from
Apr 30, 2023
Merged

DOC: migrate from sphinx-panels to sphinx-design #46227

merged 12 commits into from
Apr 30, 2023

Conversation

jorisvandenbossche
Copy link
Member

@jorisvandenbossche jorisvandenbossche commented Mar 4, 2022 •
edited by mroeschke
Loading

Eventually it is the goal that the sphinx-design package replaces the sphinx-panels package (see executablebooks/sphinx-panels#67 and https://sphinx-design.readthedocs.io/en/furo-theme/get_started.html#migrating-from-sphinx-panels, sphinx-design has the same (and more) features, but with a refactored and more flexible code base).

So this PR moves our usage of sphinx-panels to sphinx-design (at least already for the front page, still need to do the same for the getting started pages)

It gives almost identical result as we have now (screenshot is with this PR, compare with eg https://pandas.pydata.org/pandas-docs/version/1.3/):

image

@jreback jreback added the Docs label Mar 5, 2022
@jreback jreback added this to the 1.5 milestone Mar 5, 2022
@jreback
Copy link
Contributor

jreback commented Mar 5, 2022

looks like failing doc build

@datapythonista
Copy link
Member 

Extension error:
Could not import extension sphinx_design (exception: No module named 'sphinx_design')

Is a dependency missing?

@jorisvandenbossche
Copy link
Member Author

Yes, I didn't yet update the CI / requirements, because there is also more sphinx-panels usage to convert. Should have made it a draft PR!

@jorisvandenbossche jorisvandenbossche marked this pull request as draft April 5, 2022 14:59
@github-actions
Copy link
Contributor

github-actions bot commented May 8, 2022

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

@github-actions github-actions bot added the Stale label May 8, 2022
@mroeschke mroeschke removed this from the 1.5 milestone Aug 1, 2022
@jbrockmendel
Copy link
Member

is this active?

@simonjayhawkins
Copy link
Member

is this active?

thanks @jorisvandenbossche for the additional commits. Is this ready for review?

@mroeschke
Copy link
Member

Closing to clear the queue, but feel free to reopen if you have time and interest to work on it again.

@mroeschke mroeschke closed this Mar 24, 2023
@jorisvandenbossche jorisvandenbossche deleted the docs-migrate-sphinx-design branch April 20, 2023 17:15
@jorisvandenbossche jorisvandenbossche restored the docs-migrate-sphinx-design branch April 20, 2023 17:15
@jorisvandenbossche jorisvandenbossche deleted the docs-migrate-sphinx-design branch April 20, 2023 17:15
@jorisvandenbossche jorisvandenbossche restored the docs-migrate-sphinx-design branch April 20, 2023 17:15
@jorisvandenbossche jorisvandenbossche mentioned this pull request Apr 20, 2023
Closed
@mroeschke mroeschke mentioned this pull request Apr 26, 2023
Closed
5 tasks
@mroeschke
Copy link
Member

/preview

@github-actions
Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/46227/

@mroeschke
Copy link
Member

/preview

@github-actions
Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/46227/

@mroeschke
Copy link
Member

/preview

@github-actions
Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/46227/

@mroeschke mroeschke added this to the 2.1 milestone Apr 28, 2023
@mroeschke
Copy link
Member

@phofl @datapythonista @jorisvandenbossche I think this PR is ready now if you could review when you have time

@mroeschke
Copy link
Member

/preview

@github-actions
Copy link
Contributor

Website preview of this PR available at: https://pandas.pydata.org/preview/46227/

@mroeschke mroeschke marked this pull request as ready for review April 28, 2023 18:49
datapythonista
datapythonista approved these changes Apr 28, 2023
View reviewed changes
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

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

Thanks @mroeschke, looks good to me

@mroeschke mroeschke merged commit 4007617 into pandas-dev:main Apr 30, 2023
topper-123 pushed a commit to topper-123/pandas that referenced this pull request May 7, 2023
@jorisvandenbossche @mroeschke @topper-123
DOC: migrate from sphinx-panels to sphinx-design (pandas-dev#46227)
097294a 
* DOC: migrate from sphinx-panels to sphinx-design

* update css for latest pydata-sphinx-theme

* add sphinx-design to env

* further fix css

* Convert panels to grid, address warning, remove panel dependency

* Try addressing failures

* Fix css

* Fix more css

* Just use one comparison card class

---------

Co-authored-by: Matthew Roeschke <[email protected]>
Rylie-W pushed a commit to Rylie-W/pandas that referenced this pull request May 19, 2023
@jorisvandenbossche @mroeschke
DOC: migrate from sphinx-panels to sphinx-design (pandas-dev#46227)
d918a05 
* DOC: migrate from sphinx-panels to sphinx-design

* update css for latest pydata-sphinx-theme

* add sphinx-design to env

* further fix css

* Convert panels to grid, address warning, remove panel dependency

* Try addressing failures

* Fix css

* Fix more css

* Just use one comparison card class

---------

Co-authored-by: Matthew Roeschke <[email protected]>
Daquisu pushed a commit to Daquisu/pandas that referenced this pull request Jul 8, 2023
@jorisvandenbossche @mroeschke
DOC: migrate from sphinx-panels to sphinx-design (pandas-dev#46227)
86a677c 
* DOC: migrate from sphinx-panels to sphinx-design

* update css for latest pydata-sphinx-theme

* add sphinx-design to env

* further fix css

* Convert panels to grid, address warning, remove panel dependency

* Try addressing failures

* Fix css

* Fix more css

* Just use one comparison card class

---------

Co-authored-by: Matthew Roeschke <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@datapythonista datapythonista datapythonista approved these changes

Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
2.1
Development

Successfully merging this pull request may close these issues.

DOC: move from sphinx-panels to sphinx-design
6 participants
@jorisvandenbossche @jreback @datapythonista @jbrockmendel @simonjayhawkins @mroeschke