From 7e1072b82ff67c4cc11155ddcd17bcfd7c76664d Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Wed, 9 Jan 2019 23:57:45 +0000 Subject: [PATCH 1/3] DOC: Creating top-level development section, and moving pages inside --- 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 +---- 7 files changed, 17 insertions(+), 5 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 a68e5c70087e9..c9d6845107dfc 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 0000000000000..6a0572d468ae4 --- /dev/null +++ b/doc/source/development/index.rst @@ -0,0 +1,15 @@ +{{ header }} + +.. _developmente: + +=========== +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 145acbc55b85f..994836706eed8 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 @@ -161,8 +160,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 releases {% endif -%} From 95758d1f4e63cc724ed23bba201685e18fd3bb2d Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Thu, 10 Jan 2019 00:00:41 +0000 Subject: [PATCH 2/3] Fixed typo --- doc/source/development/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/development/index.rst b/doc/source/development/index.rst index 6a0572d468ae4..d67a6c3a2ca04 100644 --- a/doc/source/development/index.rst +++ b/doc/source/development/index.rst @@ -1,6 +1,6 @@ {{ header }} -.. _developmente: +.. _development: =========== Development From 2acb9bae73d44766692fda7cc661cea6a519f76c Mon Sep 17 00:00:00 2001 From: Marc Garcia Date: Thu, 10 Jan 2019 00:53:05 +0000 Subject: [PATCH 3/3] Updating path of file excluded form flake8-rst --- setup.cfg | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.cfg b/setup.cfg index 3b7d1da9a2b02..8e64004e03cb5 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 doc/source/enhancingperf.rst