Docs: List of Sanity Tests (#52986)

* Improve sanity test docs, how to run sanity tests section

docs/bin/testing_formatter.sh

@@ -3,12 +3,16 @@
 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\`\`.
 
+For information on how to run these tests, see :ref:\`sanity testing guide <testing_sanity>\`.
+
 .. toctree::
    :maxdepth: 1
 

docs/docsite/rst/dev_guide/testing_sanity.rst

@@ -14,66 +14,29 @@ The primary purpose of these tests is to enforce Ansible coding standards and re
 Tests are run with ``ansible-test sanity``.
 All available tests are run unless the ``--test`` option is used.
 
-Available Tests
-===============
-
-Tests can be listed with ``ansible-test sanity --list-tests``.
-
-This list is a combination of two different categories of tests, "Code Smell" and "Built-in".
-
-Code Smell Tests
-----------------
-
-Miscellaneous `scripts <https://github.com/ansible/ansible/tree/devel/test/sanity/code-smell/>`_ used for enforcing coding standards and requirements, identifying trip hazards, etc.
-
-These tests are listed and accessed by script name. There is no actual test named ``code-smell``.
-
-All executable scripts added to the ``code-smell`` directory are automatically detected and executed by ``ansible-test``.
-
-Scripts in the directory which fail can be skipped by adding them to `skip.txt <https://github.com/ansible/ansible/blob/devel/test/sanity/code-smell/skip.txt>`_.
-This is useful for scripts which identify issues that have not yet been resolved in the code base.
-
-Files tested are specific to the individual test scripts and are not affected by command line arguments.
 
-Built-in Tests
---------------
+How to run
+==========
 
-These tests are integrated directly into ``ansible-test``.
-All files relevant to each test are tested unless specific files are specified.
+.. code:: shell
 
-A full list of tests can be obtained by doing ``ansible-test sanity --list-tests``.
+   source hacking/env-setup
 
-ansible-doc
-~~~~~~~~~~~
+   # Run all sanity tests
+   ansible-test sanity
 
-Verifies that ``ansible-doc`` can parse module documentation on all supported python versions.
+   # Run all sanity tests against against certain files
+   ansible-test sanity lib/ansible/modules/files/template.py
 
-pep8
-~~~~
+   # Run all tests inside docker (good if you don't have dependencies installed)
+   ansible-test sanity --docker default
 
-Python static analysis for PEP 8 style guideline compliance. See :doc:`testing_pep8` for more information.
+   # Run validate-modules against a specific file
+   ansible-test sanity --test validate-modules lib/ansible/modules/files/template.py
 
-pylint
-~~~~~~
-
-Python static analysis for common programming errors.
-
-rstcheck
-~~~~~~~~
-
-Check reStructuredText files for syntax and formatting issues.
-
-shellcheck
-~~~~~~~~~~
-
-Static code analysis for shell scripts using the excellent `shellcheck <https://www.shellcheck.net/>`_ tool.
-
-validate-modules
-~~~~~~~~~~~~~~~~
-
-Analyze modules for common issues in code and documentation. See :doc:`testing_validate-modules` for more information.
+Available Tests
+===============
 
-yamllint
-~~~~~~~~
+Tests can be listed with ``ansible-test sanity --list-tests``.
 
-Check YAML files for syntax and formatting issues.
+See the full list of :ref:`sanity tests <all_sanity_tests>`, which details the various tests and details how to fix identified issues.