From 3282cf8ef21f99c4aa6d3dc9afc85cce7db933b4 Mon Sep 17 00:00:00 2001
From: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
Date: Mon, 29 Mar 2021 20:50:01 +0200
Subject: [PATCH] doc: move scripts to _scripts

Move Sphinx related content to folders with underscore prefix.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
---
 CODEOWNERS                                             |  2 +-
 doc/CMakeLists.txt                                     | 10 +++++-----
 doc/{scripts => _scripts}/extract_content.py           |  0
 doc/{scripts => _scripts}/fix_tex.py                   |  0
 doc/{scripts => _scripts}/gen_devicetree_rest.py       |  0
 doc/{scripts => _scripts}/gen_helpers.py               |  0
 doc/{scripts => _scripts}/gen_kconfig_rest.py          |  0
 .../restore_modification_times.py                      |  0
 8 files changed, 6 insertions(+), 6 deletions(-)
 rename doc/{scripts => _scripts}/extract_content.py (100%)
 rename doc/{scripts => _scripts}/fix_tex.py (100%)
 rename doc/{scripts => _scripts}/gen_devicetree_rest.py (100%)
 rename doc/{scripts => _scripts}/gen_helpers.py (100%)
 rename doc/{scripts => _scripts}/gen_kconfig_rest.py (100%)
 rename doc/{scripts => _scripts}/restore_modification_times.py (100%)

diff --git a/CODEOWNERS b/CODEOWNERS
index 68808eb8099..3e479f9e462 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -150,7 +150,7 @@
 /doc/                                     @dbkinder
 /doc/guides/coccinelle.rst                @himanshujha199640 @JuliaLawall
 /doc/CMakeLists.txt                       @carlescufi
-/doc/scripts/                             @carlescufi
+/doc/_scripts/                            @carlescufi
 /doc/guides/bluetooth/                    @joerchan @jhedberg @Vudentz
 /doc/guides/dts/                          @galak @mbolivar-nordic
 /doc/reference/bluetooth/                 @joerchan @jhedberg @Vudentz
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
index c98033eb7b8..6216fe06110 100644
--- a/doc/CMakeLists.txt
+++ b/doc/CMakeLists.txt
@@ -114,7 +114,7 @@ configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
 set(EXTRACT_CONTENT_COMMAND
   ${CMAKE_COMMAND} -E env
   ZEPHYR_BASE=${ZEPHYR_BASE}
-  ${PYTHON_EXECUTABLE} scripts/extract_content.py
+  ${PYTHON_EXECUTABLE} _scripts/extract_content.py
   # Ignore any files in the output directory.
   --ignore ${CMAKE_CURRENT_BINARY_DIR}
   # Copy all files in doc to the rst folder.
@@ -183,7 +183,7 @@ add_custom_command(
 add_custom_target(
   doxy_real_modified_times
   COMMAND ${CMAKE_COMMAND} -E env
-    ${PYTHON_EXECUTABLE} scripts/restore_modification_times.py
+    ${PYTHON_EXECUTABLE} _scripts/restore_modification_times.py
     --loglevel  WARN  ${DOXY_OUT}/xml
   WORKING_DIRECTORY ${CMAKE_CURRENT_LIST_DIR}
   DEPENDS ${DOXY_RUN_TSTAMP}
@@ -202,7 +202,7 @@ else()
 endif()
 
 set(KI_SCRIPT ${ZEPHYR_BASE}/scripts/filter-known-issues.py)
-set(FIX_TEX_SCRIPT ${ZEPHYR_BASE}/doc/scripts/fix_tex.py)
+set(FIX_TEX_SCRIPT ${ZEPHYR_BASE}/doc/_scripts/fix_tex.py)
 set(CONF_DIR ${ZEPHYR_BASE}/.known-issues/doc)
 
 #
@@ -257,7 +257,7 @@ add_custom_target(
   KCONFIG_TURBO_MODE=${KCONFIG_TURBO_MODE}
   KCONFIG_DOC_MODE=1
   ${ZEPHYR_KCONFIG_MODULES}
-    ${PYTHON_EXECUTABLE} scripts/gen_kconfig_rest.py ${RST_OUT}/doc/reference/kconfig/
+    ${PYTHON_EXECUTABLE} _scripts/gen_kconfig_rest.py ${RST_OUT}/doc/reference/kconfig/
       --separate-all-index
       --keep-module-paths
       --modules Architecture,arch,${ZEPHYR_BASE}/arch
@@ -291,7 +291,7 @@ add_custom_target(
 # - DTS_BINDINGS_RST_OUT: ${RST_OUT}/doc/reference/devicetree
 #
 
-set(GEN_DEVICETREE_REST_SCRIPT ${CMAKE_CURRENT_LIST_DIR}/scripts/gen_devicetree_rest.py)
+set(GEN_DEVICETREE_REST_SCRIPT ${CMAKE_CURRENT_LIST_DIR}/_scripts/gen_devicetree_rest.py)
 
 if(NOT DTS_ROOTS)
   set(DTS_ROOTS ${ZEPHYR_BASE})
diff --git a/doc/scripts/extract_content.py b/doc/_scripts/extract_content.py
similarity index 100%
rename from doc/scripts/extract_content.py
rename to doc/_scripts/extract_content.py
diff --git a/doc/scripts/fix_tex.py b/doc/_scripts/fix_tex.py
similarity index 100%
rename from doc/scripts/fix_tex.py
rename to doc/_scripts/fix_tex.py
diff --git a/doc/scripts/gen_devicetree_rest.py b/doc/_scripts/gen_devicetree_rest.py
similarity index 100%
rename from doc/scripts/gen_devicetree_rest.py
rename to doc/_scripts/gen_devicetree_rest.py
diff --git a/doc/scripts/gen_helpers.py b/doc/_scripts/gen_helpers.py
similarity index 100%
rename from doc/scripts/gen_helpers.py
rename to doc/_scripts/gen_helpers.py
diff --git a/doc/scripts/gen_kconfig_rest.py b/doc/_scripts/gen_kconfig_rest.py
similarity index 100%
rename from doc/scripts/gen_kconfig_rest.py
rename to doc/_scripts/gen_kconfig_rest.py
diff --git a/doc/scripts/restore_modification_times.py b/doc/_scripts/restore_modification_times.py
similarity index 100%
rename from doc/scripts/restore_modification_times.py
rename to doc/_scripts/restore_modification_times.py