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

Merged
merged 12 commits into from
Apr 30, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
f9f470e
DOC: migrate from sphinx-panels to sphinx-design
jorisvandenbossche Aug 27, 2021
4dd8141
Merge remote-tracking branch 'upstream/main' into docs-migrate-sphinx…
jorisvandenbossche Dec 2, 2022
344201d
update css for latest pydata-sphinx-theme
jorisvandenbossche Dec 2, 2022
4e3f51d
add sphinx-design to env
jorisvandenbossche Dec 2, 2022
be156b9
further fix css
jorisvandenbossche Dec 2, 2022
9bddaed
Merge branch 'main' into docs-migrate-sphinx-design
mroeschke Apr 26, 2023
92df06b
Convert panels to grid, address warning, remove panel dependency
mroeschke Apr 27, 2023
3090553
Try addressing failures
mroeschke Apr 27, 2023
a4a0353
Merge remote-tracking branch 'upstream/main' into docs-migrate-sphinx…
mroeschke Apr 28, 2023
31db3e1
Fix css
mroeschke Apr 28, 2023
0bb740d
Fix more css
mroeschke Apr 28, 2023
823ca97
Just use one comparison card class
mroeschke Apr 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions doc/source/_static/css/getting_started.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,21 @@ ul.task-bullet > li > p:first-child {
margin: 0px;
}

.comparison-card .card-img-top {
.comparison-card .sd-card-img-top {
margin: 10px;
margin-bottom: 20px;
height: 72px;
height: 52px;
background: none !important;
}

.comparison-card-excel .card-img-top, .comparison-card-stata .card-img-top, .comparison-card-sas .card-img-top {
height: 52px;
.comparison-card .sd-btn-secondary {
background-color: #6c757d !important;
border-color: #6c757d !important;
}

.comparison-card .sd-btn-secondary:hover {
background-color: #5a6268 !important;
border-color: #545b62 !important;
}

.comparison-card .card-footer {
Expand Down Expand Up @@ -178,6 +184,16 @@ ul.task-bullet > li > p:first-child {
margin: 0 1em 1em 1em;
}

.install-card .sd-btn-secondary {
background-color: #6c757d !important;
border-color: #6c757d !important;
}

.install-card .sd-btn-secondary:hover {
background-color: #5a6268 !important;
border-color: #545b62 !important;
}

.custom-button {
background-color:#DCDCDC;
border: none;
Expand Down
35 changes: 17 additions & 18 deletions doc/source/_static/css/pandas.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,42 +12,41 @@ table {
/* Main index page overview cards */

.intro-card {
background: #fff;
border-radius: 0;
padding: 30px 10px 20px 10px;
margin: 10px 0px;
}

.intro-card p.card-text {
margin: 0px;
}

.intro-card .card-img-top {
.intro-card .sd-card-img-top {
margin: 10px;
height: 52px;
background: none !important;
}

.intro-card .card-header {
border: none;
background-color: transparent;
color: #150458 !important;
.intro-card .sd-card-title {
color: var(--pst-color-primary);
font-size: var(--pst-font-size-h5);
font-weight: bold;
padding: 2.5rem 0rem 0.5rem 0rem;
padding: 1rem 0rem 0.5rem 0rem;
}

.intro-card .card-footer {
border: none;
background-color: transparent;
.intro-card .sd-card-footer {
border: none !important;
}

.intro-card .card-footer p.card-text{
.intro-card .sd-card-footer p.sd-card-text {
max-width: 220px;
margin-left: auto;
margin-right: auto;
}

.intro-card .sd-btn-secondary {
background-color: #6c757d !important;
border-color: #6c757d !important;
}

.intro-card .sd-btn-secondary:hover {
background-color: #5a6268 !important;
border-color: #545b62 !important;
}

.card, .card img {
background-color: var(--pst-color-background);
}
8 changes: 2 additions & 6 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"matplotlib.sphinxext.plot_directive",
"numpydoc",
"sphinx_copybutton",
"sphinx_panels",
"sphinx_design",
"sphinx_toggleprompt",
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
Expand Down Expand Up @@ -143,10 +143,6 @@
# nbsphinx do not use requirejs (breaks bootstrap)
nbsphinx_requirejs_path = ""

# sphinx-panels shouldn't add bootstrap css since the pydata-sphinx-theme
# already loads it
panels_add_bootstrap_css = False

# https://sphinx-toggleprompt.readthedocs.io/en/stable/#offset
toggleprompt_offset_right = 35

Expand Down Expand Up @@ -460,7 +456,7 @@

# extlinks alias
extlinks = {
"issue": ("https://github.com/pandas-dev/pandas/issues/%s", "GH"),
"issue": ("https://github.com/pandas-dev/pandas/issues/%s", "GH %s"),
}


Expand Down
198 changes: 111 additions & 87 deletions doc/source/getting_started/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,48 +9,53 @@ Getting started
Installation
------------

.. panels::
:card: + install-card
:column: col-lg-6 col-md-6 col-sm-12 col-xs-12 p-3
.. grid:: 1 2 2 2
:gutter: 4

Working with conda?
^^^^^^^^^^^^^^^^^^^
.. grid-item-card:: Working with conda?
:class-card: install-card
:columns: 12 12 6 6
:padding: 3

pandas is part of the `Anaconda <https://docs.continuum.io/anaconda/>`__
distribution and can be installed with Anaconda or Miniconda:
pandas is part of the `Anaconda <https://docs.continuum.io/anaconda/>`__
distribution and can be installed with Anaconda or Miniconda:

++++++++++++++++++++++
++++++++++++++++++++++

.. code-block:: bash
.. code-block:: bash
conda install pandas
conda install pandas
---
.. grid-item-card:: Prefer pip?
:class-card: install-card
:columns: 12 12 6 6
:padding: 3

Prefer pip?
^^^^^^^^^^^
pandas can be installed via pip from `PyPI <https://pypi.org/project/pandas>`__.

pandas can be installed via pip from `PyPI <https://pypi.org/project/pandas>`__.
++++

++++
.. code-block:: bash
.. code-block:: bash
pip install pandas
pip install pandas
.. grid-item-card:: In-depth instructions?
:class-card: install-card
:columns: 12
:padding: 3

---
:column: col-12 p-3
Installing a specific version? Installing from source? Check the advanced
installation page.

In-depth instructions?
^^^^^^^^^^^^^^^^^^^^^^
+++

Installing a specific version? Installing from source? Check the advanced
installation page.
.. button-ref:: install
:ref-type: ref
:click-parent:
:color: secondary
:expand:

.. link-button:: ./install.html
:type: url
:text: Learn more
:classes: btn-secondary stretched-link
Learn more


.. _gentle_intro:
Expand Down Expand Up @@ -536,91 +541,110 @@ Coming from...
Are you familiar with other software for manipulating tabular data? Learn
the pandas-equivalent operations compared to software you already know:

.. panels::
:img-top-cls: dark-light
:card: + comparison-card text-center shadow
:column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex
.. grid:: 1 2 2 2
:gutter: 4
:class-container: sd-text-center sd-d-inline-flex

---
:card: + comparison-card-r
:img-top: ../_static/logo_r.svg
.. grid-item-card::
:img-top: ../_static/logo_r.svg
:columns: 12 6 6 6
:class-card: comparison-card
:shadow: md

The `R programming language <https://www.r-project.org/>`__ provides the
``data.frame`` data structure and multiple packages, such as
`tidyverse <https://www.tidyverse.org>`__ use and extend ``data.frame``
for convenient data handling functionalities similar to pandas.
The `R programming language <https://www.r-project.org/>`__ provides the
``data.frame`` data structure and multiple packages, such as
`tidyverse <https://www.tidyverse.org>`__ use and extend ``data.frame``
for convenient data handling functionalities similar to pandas.

+++
+++

.. link-button:: compare_with_r
:type: ref
:text: Learn more
:classes: btn-secondary stretched-link
.. button-ref:: compare_with_r
:ref-type: ref
:click-parent:
:color: secondary
:expand:

Learn more

---
:card: + comparison-card-sql
:img-top: ../_static/logo_sql.svg
.. grid-item-card::
:img-top: ../_static/logo_sql.svg
:columns: 12 6 6 6
:class-card: comparison-card
:shadow: md

Already familiar to ``SELECT``, ``GROUP BY``, ``JOIN``, etc.?
Most of these SQL manipulations do have equivalents in pandas.
Already familiar to ``SELECT``, ``GROUP BY``, ``JOIN``, etc.?
Most of these SQL manipulations do have equivalents in pandas.

+++
+++

.. link-button:: compare_with_sql
:type: ref
:text: Learn more
:classes: btn-secondary stretched-link
.. button-ref:: compare_with_sql
:ref-type: ref
:click-parent:
:color: secondary
:expand:

Learn more

---
:card: + comparison-card-stata
:img-top: ../_static/logo_stata.svg
.. grid-item-card::
:img-top: ../_static/logo_stata.svg
:columns: 12 6 6 6
:class-card: comparison-card
:shadow: md

The ``data set`` included in the `STATA <https://en.wikipedia.org/wiki/Stata>`__
statistical software suite corresponds to the pandas ``DataFrame``.
Many of the operations known from STATA have an equivalent in pandas.
The ``data set`` included in the `STATA <https://en.wikipedia.org/wiki/Stata>`__
statistical software suite corresponds to the pandas ``DataFrame``.
Many of the operations known from STATA have an equivalent in pandas.

+++
+++

.. link-button:: compare_with_stata
:type: ref
:text: Learn more
:classes: btn-secondary stretched-link
.. button-ref:: compare_with_stata
:ref-type: ref
:click-parent:
:color: secondary
:expand:

Learn more

---
:card: + comparison-card-excel
:img-top: ../_static/spreadsheets/logo_excel.svg
.. grid-item-card::
:img-top: ../_static/spreadsheets/logo_excel.svg
:columns: 12 6 6 6
:class-card: comparison-card
:shadow: md

Users of `Excel <https://en.wikipedia.org/wiki/Microsoft_Excel>`__
or other spreadsheet programs will find that many of the concepts are
transferrable to pandas.
Users of `Excel <https://en.wikipedia.org/wiki/Microsoft_Excel>`__
or other spreadsheet programs will find that many of the concepts are
transferrable to pandas.

+++
+++

.. link-button:: compare_with_spreadsheets
:type: ref
:text: Learn more
:classes: btn-secondary stretched-link
.. button-ref:: compare_with_spreadsheets
:ref-type: ref
:click-parent:
:color: secondary
:expand:

Learn more

---
:card: + comparison-card-sas
:img-top: ../_static/logo_sas.svg
.. grid-item-card::
:img-top: ../_static/logo_sas.svg
:columns: 12 6 6 6
:class-card: comparison-card
:shadow: md

The `SAS <https://en.wikipedia.org/wiki/SAS_(software)>`__ statistical software suite
also provides the ``data set`` corresponding to the pandas ``DataFrame``.
Also SAS vectorized operations, filtering, string processing operations,
and more have similar functions in pandas.
The `SAS <https://en.wikipedia.org/wiki/SAS_(software)>`__ statistical software suite
also provides the ``data set`` corresponding to the pandas ``DataFrame``.
Also SAS vectorized operations, filtering, string processing operations,
and more have similar functions in pandas.

+++
+++

.. link-button:: compare_with_sas
:type: ref
:text: Learn more
:classes: btn-secondary stretched-link
.. button-ref:: compare_with_sas
:ref-type: ref
:click-parent:
:color: secondary
:expand:

Learn more

Tutorials
---------
Expand Down
Loading