Add link to all module and plugin indexes (#72743) (#73099)

* Add link to all module and plugin indexes, use glob setting for toctree.
* Adjust .gitignore
* 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.

Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
(cherry picked from commit b514200126)

.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

MANIFEST.in

@@ -3,6 +3,7 @@ include COPYING
 include SYMLINK_CACHE.json
 include requirements.txt
 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

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

docs/docsite/rst/collections/all_plugins.rst

@@ -0,0 +1,11 @@
+.. _all_modules_and_plugins:
+
+Indexes of all modules and plugins
+----------------------------------
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Plugin indexes
+   :glob:
+
+   index_*

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