From 5a0ee8bc5fb40c1755eef7486edbd72198769d6f Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 23 Jan 2019 16:23:18 +0000 Subject: [PATCH] DOC: Creating top-level development section, and moving pages inside (#24691) --- doc/source/{ => development}/contributing.rst | 2 +- .../{ => development}/contributing_docstring.rst | 0 doc/source/{ => development}/developer.rst | 0 doc/source/{ => development}/extending.rst | 0 doc/source/development/index.rst | 15 +++++++++++++++ doc/source/{ => development}/internals.rst | 0 doc/source/index.rst.template | 5 +---- setup.cfg | 2 +- 8 files changed, 18 insertions(+), 6 deletions(-) rename doc/source/{ => development}/contributing.rst (99%) rename doc/source/{ => development}/contributing_docstring.rst (100%) rename doc/source/{ => development}/developer.rst (100%) rename doc/source/{ => development}/extending.rst (100%) create mode 100644 doc/source/development/index.rst rename doc/source/{ => development}/internals.rst (100%) diff --git a/doc/source/contributing.rst b/doc/source/development/contributing.rst similarity index 99% rename from doc/source/contributing.rst rename to doc/source/development/contributing.rst index a68e5c70087e9d..c9d6845107dfc3 100644 --- a/doc/source/contributing.rst +++ b/doc/source/development/contributing.rst @@ -698,7 +698,7 @@ A pull-request will be considered for merging when you have an all 'green' build then you will get a red 'X', where you can click through to see the individual failed tests. This is an example of a green build. -.. image:: _static/ci.png +.. image:: ../_static/ci.png .. note:: diff --git a/doc/source/contributing_docstring.rst b/doc/source/development/contributing_docstring.rst similarity index 100% rename from doc/source/contributing_docstring.rst rename to doc/source/development/contributing_docstring.rst diff --git a/doc/source/developer.rst b/doc/source/development/developer.rst similarity index 100% rename from doc/source/developer.rst rename to doc/source/development/developer.rst diff --git a/doc/source/extending.rst b/doc/source/development/extending.rst similarity index 100% rename from doc/source/extending.rst rename to doc/source/development/extending.rst diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst new file mode 100644 index 00000000000000..d67a6c3a2ca046 --- /dev/null +++ b/doc/source/development/index.rst @@ -0,0 +1,15 @@ +{{ header }} + +.. _development: + +=========== +Development +=========== + +.. toctree:: + :maxdepth: 2 + + contributing + internals + extending + developer diff --git a/doc/source/internals.rst b/doc/source/development/internals.rst similarity index 100% rename from doc/source/internals.rst rename to doc/source/development/internals.rst diff --git a/doc/source/index.rst.template b/doc/source/index.rst.template index 571c906acbd436..53f116a1a0e0a6 100644 --- a/doc/source/index.rst.template +++ b/doc/source/index.rst.template @@ -124,7 +124,6 @@ See the package overview for more detail about what's in the library. {% if not single_doc -%} What's New install - contributing overview 10min tutorials @@ -143,8 +142,6 @@ See the package overview for more detail about what's in the library. api/index {% endif -%} {% if not single_doc -%} - developer - internals - extending + development/index whatsnew/index {% endif -%} diff --git a/setup.cfg b/setup.cfg index 95c71826a80d4a..6143cb8446216b 100644 --- a/setup.cfg +++ b/setup.cfg @@ -47,7 +47,7 @@ ignore = E402, # module level import not at top of file exclude = doc/source/basics.rst - doc/source/contributing_docstring.rst + doc/source/development/contributing_docstring.rst [yapf]