From 762c7a5776573033e3b6668d4aeeb2101f95d890 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Fri, 4 Oct 2019 22:12:37 +0200 Subject: [PATCH] DOC: start using new bootstrap-based sphinx theme (#28623) - Use pandas-sphinx-theme in docs (from github master) - move install into getting_started + remove ecosystem from top-level navbar --- doc/redirects.csv | 1 + doc/source/conf.py | 4 ++-- doc/source/ecosystem.rst | 2 ++ doc/source/getting_started/index.rst | 1 + doc/source/{ => getting_started}/install.rst | 0 doc/source/index.rst.template | 4 +--- environment.yml | 2 ++ requirements-dev.txt | 3 ++- web/pandas/getting_started.md | 2 +- 9 files changed, 12 insertions(+), 7 deletions(-) rename doc/source/{ => getting_started}/install.rst (100%) diff --git a/doc/redirects.csv b/doc/redirects.csv index 7171496b8cff3b..a2146edde6324e 100644 --- a/doc/redirects.csv +++ b/doc/redirects.csv @@ -6,6 +6,7 @@ whatsnew,whatsnew/index release,whatsnew/index # getting started +install,getting_started/install 10min,getting_started/10min basics,getting_started/basics comparison_with_r,getting_started/comparison/comparison_with_r diff --git a/doc/source/conf.py b/doc/source/conf.py index 1da1948e452688..5e2a2db20b53c2 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -191,7 +191,7 @@ # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. -html_theme = "nature_with_gtoc" +html_theme = "pandas_sphinx_theme" # The style sheet to use for HTML and HTML Help pages. A file of that name # must exist either in Sphinx' static/ path, or in one of the custom paths @@ -204,7 +204,7 @@ # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = ["themes"] +# html_theme_path = ["themes"] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". diff --git a/doc/source/ecosystem.rst b/doc/source/ecosystem.rst index aaf2040156a45a..48c722bc16a86d 100644 --- a/doc/source/ecosystem.rst +++ b/doc/source/ecosystem.rst @@ -1,3 +1,5 @@ +:orphan: + .. _ecosystem: {{ header }} diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst index eead28830f861f..34bb4f930f1757 100644 --- a/doc/source/getting_started/index.rst +++ b/doc/source/getting_started/index.rst @@ -12,6 +12,7 @@ Getting started .. toctree:: :maxdepth: 2 + install overview 10min basics diff --git a/doc/source/install.rst b/doc/source/getting_started/install.rst similarity index 100% rename from doc/source/install.rst rename to doc/source/getting_started/install.rst diff --git a/doc/source/index.rst.template b/doc/source/index.rst.template index 6ff42eee9dad2b..9ec330c956ff17 100644 --- a/doc/source/index.rst.template +++ b/doc/source/index.rst.template @@ -40,10 +40,8 @@ See the :ref:`overview` for more detail about what's in the library. {% endif %} {% if not single_doc %} What's New in 1.0.0 - install getting_started/index user_guide/index - ecosystem {% endif -%} {% if include_api -%} reference/index @@ -54,9 +52,9 @@ See the :ref:`overview` for more detail about what's in the library. {% endif %} * :doc:`whatsnew/v1.0.0` -* :doc:`install` * :doc:`getting_started/index` + * :doc:`getting_started/install` * :doc:`getting_started/overview` * :doc:`getting_started/10min` * :doc:`getting_started/basics` diff --git a/environment.yml b/environment.yml index 7c3ec9064cba39..43d46479271251 100644 --- a/environment.yml +++ b/environment.yml @@ -94,3 +94,5 @@ dependencies: - xlwt # pandas.read_excel, DataFrame.to_excel, pandas.ExcelWriter, pandas.ExcelFile - odfpy # pandas.read_excel - pyreadstat # pandas.read_spss + - pip: + - git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master diff --git a/requirements-dev.txt b/requirements-dev.txt index e677d835b56a5d..f2904461f58a3a 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -64,4 +64,5 @@ xlrd xlsxwriter xlwt odfpy -pyreadstat \ No newline at end of file +pyreadstat +git+https://github.com/pandas-dev/pandas-sphinx-theme.git@master \ No newline at end of file diff --git a/web/pandas/getting_started.md b/web/pandas/getting_started.md index 99a7a9f4b2d608..9682cf90cad6f1 100644 --- a/web/pandas/getting_started.md +++ b/web/pandas/getting_started.md @@ -4,7 +4,7 @@ The next steps provides the easiest and recommended way to set up your environment to use pandas. Other installation options can be found in -the [advanced installation page]({{ base_url}}/docs/install.html). +the [advanced installation page]({{ base_url}}/docs/getting_started/install.html). 1. Download [Anaconda](https://www.anaconda.com/distribution/) for your operating system and the latest Python version, run the installer, and follow the steps. Detailed instructions