Make sanity index static (#2)

.gitignore

@@ -37,7 +37,6 @@ docs/docsite/rst/index.rst
 docs/docsite/rst/cli/ansible-*.rst
 docs/docsite/rst/cli/ansible.rst
 docs/docsite/rst/dev_guide/collections_galaxy_meta.rst
-docs/docsite/rst/dev_guide/testing/sanity/index.rst.new
 docs/docsite/rst/dev_guide/index.rst
 docs/docsite/rst/modules/*.rst
 docs/docsite/rst/collections/*.rst

docs/bin/clone-core.py

@@ -18,7 +18,6 @@ def main() -> None:
         'lib',
         'packaging',
         'test/lib',
-        'test/sanity',
     ]
 
     keep_files = [

docs/bin/testing_formatter.sh

@@ -1,42 +0,0 @@
-#!/bin/sh
-
-set -eux
-
-FILENAME=../docsite/rst/dev_guide/testing/sanity/index.rst
-
-cat <<- EOF >$FILENAME.new
-.. _all_sanity_tests:
-
-Sanity Tests
-============
-
-The following sanity tests are available as \`\`--test\`\` options for \`\`ansible-test sanity\`\`.
-This list is also available using \`\`ansible-test sanity --list-tests --allow-disabled\`\`.
-
-For information on how to run these tests, see :ref:\`sanity testing guide <testing_sanity>\`.
-
-.. toctree::
-   :maxdepth: 1
-
-$(for test in $(../../bin/ansible-test sanity --list-tests --allow-disabled); do echo "   ${test}"; done)
-
-EOF
-
-# By default use sha1sum which exists on Linux, if not present select the correct binary
-# based on platform defaults
-SHA_CMD="sha1sum"
-if ! command -v ${SHA_CMD} > /dev/null 2>&1; then
-    if command -v sha1 > /dev/null 2>&1; then
-        SHA_CMD="sha1"
-    elif command -v shasum > /dev/null 2>&1; then
-        SHA_CMD="shasum"
-    else
-        # exit early with an error if no hashing binary can be found since it is required later
-        exit 1
-    fi
-fi
-
-# Put file into place if it has changed
-if [ ! -f "${FILENAME}" ] || [ "$(${SHA_CMD} <$FILENAME)" != "$(${SHA_CMD} <$FILENAME.new)" ]; then
-    mv -f $FILENAME.new $FILENAME
-fi

docs/docsite/.gitignore

@@ -11,7 +11,6 @@ ansible*.xml
 .buildinfo
 objects.inv
 .doctrees
-rst/dev_guide/testing/sanity/index.rst
 rst/modules/*.rst
 rst/playbooks_keywords.rst
 rst/collections/

docs/docsite/Makefile

@@ -1,6 +1,5 @@
 OS := $(shell uname -s)
 PLUGIN_FORMATTER=../../hacking/build-ansible.py docs-build
-TESTING_FORMATTER=../bin/testing_formatter.sh
 KEYWORD_DUMPER=../../hacking/build-ansible.py document-keywords
 CONFIG_DUMPER=../../hacking/build-ansible.py document-config
 GENERATE_CLI=../../hacking/build-ansible.py generate-man
@@ -69,12 +68,12 @@ docs: htmldocs
 coredocs: core_htmldocs
 
 
-generate_rst: collections_meta config cli keywords plugins testing
-core_generate_rst: collections_meta config cli keywords core_plugins testing
+generate_rst: collections_meta config cli keywords plugins
+core_generate_rst: collections_meta config cli keywords core_plugins
 
 # At the moment localizing the plugins and collections is not required for the ongoing
 # localisation effort. It will come at a later time.
-gettext_generate_rst: collections_meta config cli keywords testing
+gettext_generate_rst: collections_meta config cli keywords
 
 # The following symlinks are necessary to produce two different docsets
 # from the same set of rst files (Ansible the package docs, and core docs).
@@ -213,8 +212,5 @@ plugins:
 core_plugins:
 	$(PLUGIN_FORMATTER) core -o rst $(EXTRA_PLUGIN_FORMATTER_ARGS) $(PLUGIN_ARGS)
 
-testing:
-	$(TESTING_FORMATTER)
-
 epub:
 	(CPUS=$(CPUS) $(MAKE) -f Makefile.sphinx epub)

docs/docsite/rst/dev_guide/testing/sanity/index.rst

@@ -0,0 +1,62 @@
+.. _all_sanity_tests:
+
+Sanity Tests
+============
+
+The following sanity tests are available as ``--test`` options for ``ansible-test sanity``.
+This list is also available using ``ansible-test sanity --list-tests --allow-disabled``.
+
+For information on how to run these tests, see :ref:`sanity testing guide <testing_sanity>`.
+
+.. toctree::
+   :maxdepth: 1
+
+   action-plugin-docs
+   ansible-doc
+   ansible-requirements
+   ansible-test-future-boilerplate
+   bin-symlinks
+   botmeta
+   changelog
+   compile
+   configure-remoting-ps1
+   docs-build
+   empty-init
+   future-import-boilerplate
+   ignores
+   import
+   integration-aliases
+   line-endings
+   metaclass-boilerplate
+   mypy
+   no-assert
+   no-basestring
+   no-dict-iteritems
+   no-dict-iterkeys
+   no-dict-itervalues
+   no-get-exception
+   no-illegal-filenames
+   no-main-display
+   no-smart-quotes
+   no-unicode-literals
+   no-unwanted-files
+   obsolete-files
+   package-data
+   pep8
+   pslint
+   pylint
+   release-names
+   replace-urlopen
+   required-and-default-attributes
+   rstcheck
+   runtime-metadata
+   sanity-docs
+   shebang
+   shellcheck
+   symlinks
+   test-constraints
+   use-argspec-type-path
+   use-compat-six
+   validate-modules
+   yamllint
+

tests/checkers/docs-build.py

@@ -19,7 +19,6 @@ def main():
         'lib',
         'packaging',
         'test/lib',
-        'test/sanity',
     ]
 
     keep_files = [