From d9b8d1c54fa1ab8c93b1b2e7d7ad371228e4421a Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 25 Sep 2019 22:21:48 +0200 Subject: [PATCH 1/5] Use pandas-sphin-theme in docs (from github master) --- doc/source/conf.py | 6 ++++-- environment.yml | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 1da1948e45268..7de35554baa6e 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,6 +20,8 @@ from numpydoc.docscrape import NumpyDocString from sphinx.ext.autosummary import _import_by_name +import pandas_sphinx_theme # noqa + logger = logging.getLogger(__name__) # https://github.com/sphinx-doc/sphinx/pull/2325/files @@ -191,7 +193,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 +206,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/environment.yml b/environment.yml index 7629fa52e7829..f95af62e912c2 100644 --- a/environment.yml +++ b/environment.yml @@ -88,3 +88,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 From 78f6b35957e75c0593b73a750cf96adf1e8a9e31 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Wed, 25 Sep 2019 22:25:52 +0200 Subject: [PATCH 2/5] move install into getting_started + remove ecosystem from top-level navbar --- doc/redirects.csv | 1 + 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 +--- 5 files changed, 5 insertions(+), 3 deletions(-) rename doc/source/{ => getting_started}/install.rst (100%) diff --git a/doc/redirects.csv b/doc/redirects.csv index a1504f9175480..8c8079bb3fd2b 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/ecosystem.rst b/doc/source/ecosystem.rst index aaf2040156a45..48c722bc16a86 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 eead28830f861..34bb4f930f175 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 f5669626aa2b3..b7cb8bfbdcebc 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` From 1cfba0a87152d59c7a37e9e18afc60f1dbf10b78 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 26 Sep 2019 08:25:25 +0200 Subject: [PATCH 3/5] generate requirements.txt --- requirements-dev.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/requirements-dev.txt b/requirements-dev.txt index fd8e6378240b4..3849504f640a8 100644 --- a/requirements-dev.txt +++ b/requirements-dev.txt @@ -59,4 +59,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 From 5f5a609008e671fcb924d71ec612d67151131a99 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 26 Sep 2019 22:26:20 +0200 Subject: [PATCH 4/5] update link --- web/pandas/getting_started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/web/pandas/getting_started.md b/web/pandas/getting_started.md index 99a7a9f4b2d60..9682cf90cad6f 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 From 35c34c7c6a651c1550a55ca25293f436273112a7 Mon Sep 17 00:00:00 2001 From: Joris Van den Bossche Date: Thu, 26 Sep 2019 22:27:15 +0200 Subject: [PATCH 5/5] remove import --- doc/source/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 7de35554baa6e..5e2a2db20b53c 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,8 +20,6 @@ from numpydoc.docscrape import NumpyDocString from sphinx.ext.autosummary import _import_by_name -import pandas_sphinx_theme # noqa - logger = logging.getLogger(__name__) # https://github.com/sphinx-doc/sphinx/pull/2325/files