Skip to content

DOC: Try building docs with sphinx-design #52945

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions doc/source/conf.py
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
4 changes: 2 additions & 2 deletions doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Getting started
Installation
------------

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

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

.. panels::
.. grid::
: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
Expand Down
2 changes: 1 addition & 1 deletion doc/source/index.rst.template
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ easy-to-use data structures and data analysis tools for the `Python <https://www
programming language.

{% if not single_doc -%}
.. panels::
.. grid::
:card: + intro-card text-center
:column: col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex

Expand Down
2 changes: 1 addition & 1 deletion environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ dependencies:
- pydata-sphinx-theme<0.11
- pytest-cython # doctest
- sphinx
- sphinx-panels
- sphinx-design
- sphinx-copybutton
- types-python-dateutil
- types-PyMySQL
Expand Down
2 changes: 1 addition & 1 deletion requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ numpydoc
pydata-sphinx-theme<0.11
pytest-cython
sphinx
sphinx-panels
sphinx-design
sphinx-copybutton
types-python-dateutil
types-PyMySQL
Expand Down