From 4b937ff59127bf0edec8e07a667fa222bf2e3b4e Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 23 Jan 2019 17:52:11 +0000 Subject: [PATCH] DOC: Creating top-level getting started section, and moving pages inside (#24678) --- doc/source/{ => getting_started}/10min.rst | 0 doc/source/{ => getting_started}/basics.rst | 0 doc/source/{ => getting_started}/dsintro.rst | 0 doc/source/getting_started/index.rst | 16 ++++++++++++++++ doc/source/{ => getting_started}/overview.rst | 2 +- doc/source/{ => getting_started}/tutorials.rst | 0 doc/source/index.rst.template | 6 +----- setup.cfg | 2 +- 8 files changed, 19 insertions(+), 7 deletions(-) rename doc/source/{ => getting_started}/10min.rst (100%) rename doc/source/{ => getting_started}/basics.rst (100%) rename doc/source/{ => getting_started}/dsintro.rst (100%) create mode 100644 doc/source/getting_started/index.rst rename doc/source/{ => getting_started}/overview.rst (99%) rename doc/source/{ => getting_started}/tutorials.rst (100%) diff --git a/doc/source/10min.rst b/doc/source/getting_started/10min.rst similarity index 100% rename from doc/source/10min.rst rename to doc/source/getting_started/10min.rst diff --git a/doc/source/basics.rst b/doc/source/getting_started/basics.rst similarity index 100% rename from doc/source/basics.rst rename to doc/source/getting_started/basics.rst diff --git a/doc/source/dsintro.rst b/doc/source/getting_started/dsintro.rst similarity index 100% rename from doc/source/dsintro.rst rename to doc/source/getting_started/dsintro.rst diff --git a/doc/source/getting_started/index.rst b/doc/source/getting_started/index.rst new file mode 100644 index 0000000000000..116efe79beef1 --- /dev/null +++ b/doc/source/getting_started/index.rst @@ -0,0 +1,16 @@ +{{ header }} + +.. _getting_started: + +=============== +Getting started +=============== + +.. toctree:: + :maxdepth: 2 + + overview + 10min + basics + dsintro + tutorials diff --git a/doc/source/overview.rst b/doc/source/getting_started/overview.rst similarity index 99% rename from doc/source/overview.rst rename to doc/source/getting_started/overview.rst index b98e2d4b9963c..1e07df47aadca 100644 --- a/doc/source/overview.rst +++ b/doc/source/getting_started/overview.rst @@ -119,5 +119,5 @@ The information about current institutional partners can be found on `pandas web License ------- -.. literalinclude:: ../../LICENSE +.. literalinclude:: ../../../LICENSE diff --git a/doc/source/tutorials.rst b/doc/source/getting_started/tutorials.rst similarity index 100% rename from doc/source/tutorials.rst rename to doc/source/getting_started/tutorials.rst diff --git a/doc/source/index.rst.template b/doc/source/index.rst.template index 53f116a1a0e0a..bc420a906b59c 100644 --- a/doc/source/index.rst.template +++ b/doc/source/index.rst.template @@ -124,12 +124,8 @@ See the package overview for more detail about what's in the library. {% if not single_doc -%} What's New install - overview - 10min - tutorials + getting_started/index cookbook - dsintro - basics user_guide/index r_interface ecosystem diff --git a/setup.cfg b/setup.cfg index 6143cb8446216..7155cc1013544 100644 --- a/setup.cfg +++ b/setup.cfg @@ -46,7 +46,7 @@ ignore = E402, # module level import not at top of file E711, # comparison to none should be 'if cond is none:' exclude = - doc/source/basics.rst + doc/source/getting_started/basics.rst doc/source/development/contributing_docstring.rst