From 58d7278ab79b400a4606b29f85ad1ec026a2ca9f Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Fri, 27 Nov 2020 21:27:34 +0100 Subject: [PATCH 1/9] Add link to all module and plugin indexes. --- docs/docsite/rst/collections/all_plugins.rst | 22 ++++++++++++++++++++ docs/docsite/rst/index.rst | 1 + 2 files changed, 23 insertions(+) create mode 100644 docs/docsite/rst/collections/all_plugins.rst diff --git a/docs/docsite/rst/collections/all_plugins.rst b/docs/docsite/rst/collections/all_plugins.rst new file mode 100644 index 00000000000000..b3f67d5457fe85 --- /dev/null +++ b/docs/docsite/rst/collections/all_plugins.rst @@ -0,0 +1,22 @@ +.. _all_modules_and_plugins: + +Indexes of all modules and plugins +---------------------------------- + +.. toctree:: + :maxdepth: 1 + :caption: Plugin indexes + + index_module + index_become + index_cache + index_callback + index_cliconf + index_connection + index_httpapi + index_inventory + index_lookup + index_netconf + index_shell + index_strategy + index_vars diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst index 4c99b5024940e8..c001115d90f091 100644 --- a/docs/docsite/rst/index.rst +++ b/docs/docsite/rst/index.rst @@ -75,6 +75,7 @@ Ansible releases a new major release of Ansible approximately three to four time :caption: Reference & Appendices collections/index + collections/all_plugins reference_appendices/playbooks_keywords reference_appendices/common_return_values reference_appendices/config From 66e09663c12fa1839d33cf025443afcf2e6101dd Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 6 Dec 2020 15:48:33 +0100 Subject: [PATCH 2/9] Use glob setting for toctree. --- docs/docsite/rst/collections/all_plugins.rst | 15 ++------------- 1 file changed, 2 insertions(+), 13 deletions(-) diff --git a/docs/docsite/rst/collections/all_plugins.rst b/docs/docsite/rst/collections/all_plugins.rst index b3f67d5457fe85..35232f7db63642 100644 --- a/docs/docsite/rst/collections/all_plugins.rst +++ b/docs/docsite/rst/collections/all_plugins.rst @@ -6,17 +6,6 @@ Indexes of all modules and plugins .. toctree:: :maxdepth: 1 :caption: Plugin indexes + :glob: - index_module - index_become - index_cache - index_callback - index_cliconf - index_connection - index_httpapi - index_inventory - index_lookup - index_netconf - index_shell - index_strategy - index_vars + index_* From 74ae50a734d7ca6c904f3fdc91b71aa8bd7e5b4a Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 6 Dec 2020 16:22:03 +0100 Subject: [PATCH 3/9] Explicitly include new file. --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) diff --git a/MANIFEST.in b/MANIFEST.in index c2862c3190e84f..ac8c56a32650df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,6 +4,7 @@ include SYMLINK_CACHE.json include requirements.txt include shippable.yml recursive-include docs * +include docs/docsite/rst/collections/all_plugins.rst exclude docs/docsite/rst_warnings recursive-exclude docs/docsite/_build * recursive-exclude docs/docsite/_extensions *.pyc *.pyo From bd47e82eadbf18b1f4736c62fde47f6e15191723 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Sun, 6 Dec 2020 16:23:25 +0100 Subject: [PATCH 4/9] Move all_plugins one level up. --- MANIFEST.in | 1 - docs/docsite/rst/{collections => }/all_plugins.rst | 2 +- docs/docsite/rst/index.rst | 2 +- 3 files changed, 2 insertions(+), 3 deletions(-) rename docs/docsite/rst/{collections => }/all_plugins.rst (88%) diff --git a/MANIFEST.in b/MANIFEST.in index ac8c56a32650df..c2862c3190e84f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,7 +4,6 @@ include SYMLINK_CACHE.json include requirements.txt include shippable.yml recursive-include docs * -include docs/docsite/rst/collections/all_plugins.rst exclude docs/docsite/rst_warnings recursive-exclude docs/docsite/_build * recursive-exclude docs/docsite/_extensions *.pyc *.pyo diff --git a/docs/docsite/rst/collections/all_plugins.rst b/docs/docsite/rst/all_plugins.rst similarity index 88% rename from docs/docsite/rst/collections/all_plugins.rst rename to docs/docsite/rst/all_plugins.rst index 35232f7db63642..44b1a69ef4d42e 100644 --- a/docs/docsite/rst/collections/all_plugins.rst +++ b/docs/docsite/rst/all_plugins.rst @@ -8,4 +8,4 @@ Indexes of all modules and plugins :caption: Plugin indexes :glob: - index_* + collections/index_* diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst index c001115d90f091..9acc318cb45d24 100644 --- a/docs/docsite/rst/index.rst +++ b/docs/docsite/rst/index.rst @@ -75,7 +75,7 @@ Ansible releases a new major release of Ansible approximately three to four time :caption: Reference & Appendices collections/index - collections/all_plugins + all_plugins reference_appendices/playbooks_keywords reference_appendices/common_return_values reference_appendices/config From e033c7242717e87e6166348bd4a1fb7831a801ee Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 9 Dec 2020 21:58:11 +0100 Subject: [PATCH 5/9] Revert "Move all_plugins one level up." This reverts commit bd47e82eadbf18b1f4736c62fde47f6e15191723. --- MANIFEST.in | 1 + docs/docsite/rst/{ => collections}/all_plugins.rst | 2 +- docs/docsite/rst/index.rst | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) rename docs/docsite/rst/{ => collections}/all_plugins.rst (88%) diff --git a/MANIFEST.in b/MANIFEST.in index c2862c3190e84f..ac8c56a32650df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,6 +4,7 @@ include SYMLINK_CACHE.json include requirements.txt include shippable.yml recursive-include docs * +include docs/docsite/rst/collections/all_plugins.rst exclude docs/docsite/rst_warnings recursive-exclude docs/docsite/_build * recursive-exclude docs/docsite/_extensions *.pyc *.pyo diff --git a/docs/docsite/rst/all_plugins.rst b/docs/docsite/rst/collections/all_plugins.rst similarity index 88% rename from docs/docsite/rst/all_plugins.rst rename to docs/docsite/rst/collections/all_plugins.rst index 44b1a69ef4d42e..35232f7db63642 100644 --- a/docs/docsite/rst/all_plugins.rst +++ b/docs/docsite/rst/collections/all_plugins.rst @@ -8,4 +8,4 @@ Indexes of all modules and plugins :caption: Plugin indexes :glob: - collections/index_* + index_* diff --git a/docs/docsite/rst/index.rst b/docs/docsite/rst/index.rst index 9acc318cb45d24..c001115d90f091 100644 --- a/docs/docsite/rst/index.rst +++ b/docs/docsite/rst/index.rst @@ -75,7 +75,7 @@ Ansible releases a new major release of Ansible approximately three to four time :caption: Reference & Appendices collections/index - all_plugins + collections/all_plugins reference_appendices/playbooks_keywords reference_appendices/common_return_values reference_appendices/config From f30d99c861b65f1968c402abdad6ff93c15d68b8 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 9 Dec 2020 21:58:21 +0100 Subject: [PATCH 6/9] Revert "Explicitly include new file." This reverts commit 74ae50a734d7ca6c904f3fdc91b71aa8bd7e5b4a. --- MANIFEST.in | 1 - 1 file changed, 1 deletion(-) diff --git a/MANIFEST.in b/MANIFEST.in index ac8c56a32650df..c2862c3190e84f 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,7 +4,6 @@ include SYMLINK_CACHE.json include requirements.txt include shippable.yml recursive-include docs * -include docs/docsite/rst/collections/all_plugins.rst exclude docs/docsite/rst_warnings recursive-exclude docs/docsite/_build * recursive-exclude docs/docsite/_extensions *.pyc *.pyo From 58e8557e65d72adbe363ce6ac6068a2f44963656 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 9 Dec 2020 21:59:47 +0100 Subject: [PATCH 7/9] Adjust .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 906b538952bc34..5d7c778c3e8576 100644 --- a/.gitignore +++ b/.gitignore @@ -38,6 +38,7 @@ docs/docsite/rst/dev_guide/collections_galaxy_meta.rst docs/docsite/rst/dev_guide/testing/sanity/index.rst.new docs/docsite/rst/modules/*.rst docs/docsite/rst/collections/*.rst +!docs/docsite/rst/collections/all_plugins.rst docs/docsite/rst/collections/*/*.rst docs/docsite/rst/playbooks_directives.rst docs/docsite/rst/plugins_by_category.rst From f65525637e5c0c37d35b01f6b6d5961cb8c119ab Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Wed, 9 Dec 2020 22:27:28 +0100 Subject: [PATCH 8/9] Revert "Revert "Explicitly include new file."" This reverts commit f30d99c861b65f1968c402abdad6ff93c15d68b8. --- MANIFEST.in | 1 + 1 file changed, 1 insertion(+) diff --git a/MANIFEST.in b/MANIFEST.in index c2862c3190e84f..ac8c56a32650df 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -4,6 +4,7 @@ include SYMLINK_CACHE.json include requirements.txt include shippable.yml recursive-include docs * +include docs/docsite/rst/collections/all_plugins.rst exclude docs/docsite/rst_warnings recursive-exclude docs/docsite/_build * recursive-exclude docs/docsite/_extensions *.pyc *.pyo From 83ac8cd5dd130e0cfc6cf03fb8df91a887bde05a Mon Sep 17 00:00:00 2001 From: Toshio Kuratomi Date: Tue, 15 Dec 2020 10:49:10 -0800 Subject: [PATCH 9/9] Fix docs make clean Now that there's a static file in rst/collections, we have to be more explicit about how we clean the generated files out of that directory. --- docs/docsite/Makefile | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/docsite/Makefile b/docs/docsite/Makefile index e9d05b84dc0025..b0e1f62f3e36bd 100644 --- a/docs/docsite/Makefile +++ b/docs/docsite/Makefile @@ -94,7 +94,11 @@ clean: rm -f rst/reference_appendices/playbooks_keywords.rst rm -f rst/dev_guide/collections_galaxy_meta.rst rm -f rst/cli/*.rst - rm -rf rst/collections/* + for filename in `ls rst/collections/` ; do \ + if test x"$$filename" != x'all_plugins.rst' ; then \ + rm -rf "rst/collections/$$filename"; \ + fi \ + done @echo "Cleaning up legacy generated rst locations" rm -rf rst/modules rm -f rst/plugins/*/*.rst