Skip to content

Commit 6396bc3

Browse files
DOC: start using new bootstrap-based sphinx theme (pandas-dev#28623)
- Use pandas-sphinx-theme in docs (from github master) - move install into getting_started + remove ecosystem from top-level navbar
1 parent 6ff044e commit 6396bc3

File tree

9 files changed

+12
-7
lines changed

9 files changed

+12
-7
lines changed

doc/redirects.csv

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ whatsnew,whatsnew/index
66
release,whatsnew/index
77

88
# getting started
9+
install,getting_started/install
910
10min,getting_started/10min
1011
basics,getting_started/basics
1112
comparison_with_r,getting_started/comparison/comparison_with_r

doc/source/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@
191191

192192
# The theme to use for HTML and HTML Help pages. Major themes that come with
193193
# Sphinx are currently 'default' and 'sphinxdoc'.
194-
html_theme = "nature_with_gtoc"
194+
html_theme = "pandas_sphinx_theme"
195195

196196
# The style sheet to use for HTML and HTML Help pages. A file of that name
197197
# must exist either in Sphinx' static/ path, or in one of the custom paths
@@ -204,7 +204,7 @@
204204
# html_theme_options = {}
205205

206206
# Add any paths that contain custom themes here, relative to this directory.
207-
html_theme_path = ["themes"]
207+
# html_theme_path = ["themes"]
208208

209209
# The name for this set of Sphinx documents. If None, it defaults to
210210
# "<project> v<release> documentation".

doc/source/ecosystem.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
.. _ecosystem:
24

35
{{ header }}

doc/source/getting_started/index.rst

+1
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Getting started
1212
.. toctree::
1313
:maxdepth: 2
1414

15+
install
1516
overview
1617
10min
1718
basics
File renamed without changes.

doc/source/index.rst.template

+1-3
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,8 @@ See the :ref:`overview` for more detail about what's in the library.
4040
{% endif %}
4141
{% if not single_doc %}
4242
What's New in 1.0.0 <whatsnew/v1.0.0>
43-
install
4443
getting_started/index
4544
user_guide/index
46-
ecosystem
4745
{% endif -%}
4846
{% if include_api -%}
4947
reference/index
@@ -54,9 +52,9 @@ See the :ref:`overview` for more detail about what's in the library.
5452
{% endif %}
5553

5654
* :doc:`whatsnew/v1.0.0`
57-
* :doc:`install`
5855
* :doc:`getting_started/index`
5956

57+
* :doc:`getting_started/install`
6058
* :doc:`getting_started/overview`
6159
* :doc:`getting_started/10min`
6260
* :doc:`getting_started/basics`

environment.yml

+2
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,5 @@ dependencies:
9494
- xlwt # pandas.read_excel, DataFrame.to_excel, pandas.ExcelWriter, pandas.ExcelFile
9595
- odfpy # pandas.read_excel
9696
- pyreadstat # pandas.read_spss
97+
- pip:
98+
- git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master

requirements-dev.txt

+2-1
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,5 @@ xlrd
6464
xlsxwriter
6565
xlwt
6666
odfpy
67-
pyreadstat
67+
pyreadstat
68+
git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master

web/pandas/getting_started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
The next steps provides the easiest and recommended way to set up your
66
environment to use pandas. Other installation options can be found in
7-
the [advanced installation page]({{ base_url}}/docs/install.html).
7+
the [advanced installation page]({{ base_url}}/docs/getting_started/install.html).
88

99
1. Download [Anaconda](https://www.anaconda.com/distribution/) for your operating system and
1010
the latest Python version, run the installer, and follow the steps. Detailed instructions

0 commit comments

Comments
 (0)