From 2e66d739405da57c03552bad374a600b1bab78c3 Mon Sep 17 00:00:00 2001 From: Matt Clay Date: Fri, 26 Jul 2019 08:51:09 -0700 Subject: =?UTF-8?q?Remove=20redundant=20"Sanity=20Tests=20=C2=BB"=20from?= =?UTF-8?q?=20page=20title.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The docs now have multi-level breadcrumbs so including "Sanity Tests »" in the title on a sanity test page is redundant. (cherry picked from commit b4494fa5476a055df343f1c6d17ea0a135d4498a) (cherry picked from commit dd42aac8780b49dc7d363cdef28dbfd75cfe2b1e) --- docs/docsite/rst/dev_guide/testing/sanity/ansible-doc.rst | 4 ++-- .../rst/dev_guide/testing/sanity/ansible-var-precedence-check.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/azure-requirements.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/changelog.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/compile.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/configure-remoting-ps1.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/docs-build.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/empty-init.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/import.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/line-endings.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-assert.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-basestring.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-dict-iteritems.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-dict-iterkeys.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-dict-itervalues.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-tests-as-filters.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-underscore-variable.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-unicode-literals.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/pep8.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/pslint.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/pylint-ansible-test.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/pylint.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/replace-urlopen.rst | 4 ++-- .../rst/dev_guide/testing/sanity/required-and-default-attributes.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/rstcheck.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/sanity-docs.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/shebang.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/shellcheck.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/symlinks.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/test-constraints.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/use-compat-six.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/validate-modules.rst | 4 ++-- docs/docsite/rst/dev_guide/testing/sanity/yamllint.rst | 4 ++-- 40 files changed, 80 insertions(+), 80 deletions(-) diff --git a/docs/docsite/rst/dev_guide/testing/sanity/ansible-doc.rst b/docs/docsite/rst/dev_guide/testing/sanity/ansible-doc.rst index 20a6a3ed78..9f2c4f5f45 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/ansible-doc.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/ansible-doc.rst @@ -1,4 +1,4 @@ -Sanity Tests » ansible-doc -========================== +ansible-doc +=========== Verifies that ``ansible-doc`` can parse module documentation on all supported Python versions. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/ansible-var-precedence-check.rst b/docs/docsite/rst/dev_guide/testing/sanity/ansible-var-precedence-check.rst index f8354c9a37..1906886f4f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/ansible-var-precedence-check.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/ansible-var-precedence-check.rst @@ -1,6 +1,6 @@ :orphan: -Sanity Tests » ansible-var-precedence-check -=========================================== +ansible-var-precedence-check +============================ Check the order of precedence for Ansible variables against :ref:`ansible_variable_precedence`. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/azure-requirements.rst b/docs/docsite/rst/dev_guide/testing/sanity/azure-requirements.rst index a11534e3e1..e5c51b9e7f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/azure-requirements.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/azure-requirements.rst @@ -1,5 +1,5 @@ -Sanity Tests » azure-requirements -================================= +azure-requirements +================== Update the Azure integration test requirements file when changes are made to the Azure packaging requirements file: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst b/docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst index e07d84654c..48807a93a0 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/boilerplate.rst @@ -1,5 +1,5 @@ -Sanity Tests » boilerplate -========================== +boilerplate +=========== Most Python files should include the following boilerplate: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst b/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst index 67ac6a1233..d065987383 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/changelog.rst @@ -1,5 +1,5 @@ -Sanity Tests » changelog -======================== +changelog +========= Basic linting of changelog fragments with yamllint and rstcheck. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/compile.rst b/docs/docsite/rst/dev_guide/testing/sanity/compile.rst index 55a49b60b1..207ed61504 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/compile.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/compile.rst @@ -1,4 +1,4 @@ -Sanity Tests » compile -====================== +compile +======= See :doc:`../../testing_compile` for more information. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/configure-remoting-ps1.rst b/docs/docsite/rst/dev_guide/testing/sanity/configure-remoting-ps1.rst index 3c847c5b3f..e83bc78d89 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/configure-remoting-ps1.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/configure-remoting-ps1.rst @@ -1,5 +1,5 @@ -Sanity Tests » configure-remoting-ps1 -===================================== +configure-remoting-ps1 +====================== The file ``examples/scripts/ConfigureRemotingForAnsible.ps1`` is required and must be a regular file. It is used by external automated processes and cannot be moved, renamed or replaced with a symbolic link. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/docs-build.rst b/docs/docsite/rst/dev_guide/testing/sanity/docs-build.rst index 001d211913..9e59e992b9 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/docs-build.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/docs-build.rst @@ -1,6 +1,6 @@ :orphan: -Sanity Tests » docs-build -========================= +docs-build +========== Verifies that ``make singlehtmldocs`` in ``docs/docsite/`` completes without errors. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/empty-init.rst b/docs/docsite/rst/dev_guide/testing/sanity/empty-init.rst index 391fdf67a8..e87bb71ed6 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/empty-init.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/empty-init.rst @@ -1,5 +1,5 @@ -Sanity Tests » empty-init -========================= +empty-init +========== The ``__init__.py`` files under the following directories must be empty. For some of these (modules and tests), ``__init__.py`` files with code won't be used. For others (module_utils), we want the diff --git a/docs/docsite/rst/dev_guide/testing/sanity/import.rst b/docs/docsite/rst/dev_guide/testing/sanity/import.rst index 1212ce2a34..4b29636a54 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/import.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/import.rst @@ -1,5 +1,5 @@ -Sanity Tests » import -===================== +import +====== All Python imports in ``lib/ansible/modules/`` and ``lib/ansible/module_utils/`` which are not from the Python standard library must be imported in a try/except ImportError block. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst b/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst index 4e143c3185..4a693429f9 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/integration-aliases.rst @@ -1,5 +1,5 @@ -Sanity Tests » integration-aliases -================================== +integration-aliases +=================== Integration tests are executed by ``ansible-test`` and reside in directories under ``test/integration/targets/``. Each test MUST have an ``aliases`` file to control test execution. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/line-endings.rst b/docs/docsite/rst/dev_guide/testing/sanity/line-endings.rst index b2848e28ac..d56cfc12e5 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/line-endings.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/line-endings.rst @@ -1,4 +1,4 @@ -Sanity Tests » line-endings -=========================== +line-endings +============ All files must use ``\n`` for line endings instead of ``\r\n``. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-assert.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-assert.rst index 0dc7bdf891..489f917f62 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-assert.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-assert.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-assert -======================== +no-assert +========= Do not use ``assert`` in production Ansible python code. When running Python with optimizations, Python will remove ``assert`` statements, potentially diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-basestring.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-basestring.rst index 1c44da6bd5..f1b6ba92c9 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-basestring.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-basestring.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-basestring -============================ +no-basestring +============= Do not use ``isinstance(s, basestring)`` as basestring has been removed in Python3. You can import ``string_types``, ``binary_type``, or ``text_type`` diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iteritems.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iteritems.rst index 1f3db3af06..e231c796c4 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iteritems.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iteritems.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-dict-iteritems -================================ +no-dict-iteritems +================= The ``dict.iteritems`` method has been removed in Python 3. There are two recommended alternatives: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iterkeys.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iterkeys.rst index ca81daef23..9dc4a97855 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iterkeys.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-iterkeys.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-dict-iterkeys -=============================== +no-dict-iterkeys +================ The ``dict.iterkeys`` method has been removed in Python 3. Use the following instead: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-itervalues.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-itervalues.rst index 410988dc81..979450e418 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-dict-itervalues.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-dict-itervalues.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-dict-itervalues -================================= +no-dict-itervalues +================== The ``dict.itervalues`` method has been removed in Python 3. There are two recommended alternatives: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst index 7e5d4f820a..584fbc869f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-get-exception.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-get-exception -=============================== +no-get-exception +================ We created a function, ``ansible.module_utils.pycompat24.get_exception`` to help retrieve exceptions in a manner compatible with Python 2.4 through diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst index aa039e5a0a..6e6f565eed 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-illegal-filenames.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-illegal-filenames -=================================== +no-illegal-filenames +==================== Files and directories should not contain illegal characters or names so that Ansible can be checked out on any Operating System. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst index 5432b2c63e..50dc7bafc9 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-smart-quotes.rst @@ -1,4 +1,4 @@ -Sanity Tests » no-smart-quotes -============================== +no-smart-quotes +=============== Smart quotes (``”“‘’``) should not be used. Use plain ascii quotes (``"'``) instead. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-tests-as-filters.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-tests-as-filters.rst index a20c6c5fc7..c1a5b8f967 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-tests-as-filters.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-tests-as-filters.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-tests-as-filters -================================== +no-tests-as-filters +=================== Using Ansible provided Jinja2 tests as filters will be removed in Ansible 2.9. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-underscore-variable.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-underscore-variable.rst index 31376438b7..2aa5ffef0b 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-underscore-variable.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-underscore-variable.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-underscore-variable -===================================== +no-underscore-variable +====================== In the future, Ansible may use the identifier ``_`` to internationalize its message strings. To be ready for that, we need to make sure that there are diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-unicode-literals.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-unicode-literals.rst index fefa72c307..c4f3586a73 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-unicode-literals.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-unicode-literals.rst @@ -1,5 +1,5 @@ -Sanity Tests » no-unicode_literals -================================== +no-unicode_literals +=================== The use of :code:`from __future__ import unicode_literals` has been deemed an anti-pattern. The problems with it are: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst b/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst index 04c55a8148..fdaf07b097 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/no-wildcard-import.rst @@ -1,7 +1,7 @@ :orphan: -Sanity Tests » no-wildcard-import -================================= +no-wildcard-import +================== Using :code:`import *` is a bad habit which pollutes your namespace, hinders debugging, and interferes with static analysis of code. For those reasons, we diff --git a/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst b/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst index 7570f0fc92..808e909d1f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst @@ -1,5 +1,5 @@ -Sanity Tests » pep8 -=================== +pep8 +==== Python static analysis for PEP 8 style guideline compliance. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/pslint.rst b/docs/docsite/rst/dev_guide/testing/sanity/pslint.rst index 0af0ab4892..baa4fa034f 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/pslint.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/pslint.rst @@ -1,4 +1,4 @@ -Sanity Tests » pslint -===================== +pslint +====== PowerShell static analysis for common programming errors using `PSScriptAnalyzer `_. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/pylint-ansible-test.rst b/docs/docsite/rst/dev_guide/testing/sanity/pylint-ansible-test.rst index 744d181cda..a80ddc1eb0 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/pylint-ansible-test.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/pylint-ansible-test.rst @@ -1,7 +1,7 @@ :orphan: -Sanity Tests » pylint-ansible-test -================================== +pylint-ansible-test +=================== Python static analysis for common programming errors. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/pylint.rst b/docs/docsite/rst/dev_guide/testing/sanity/pylint.rst index b467756143..2b2ef9e53b 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/pylint.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/pylint.rst @@ -1,4 +1,4 @@ -Sanity Tests » pylint -===================== +pylint +====== Python static analysis for common programming errors. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/replace-urlopen.rst b/docs/docsite/rst/dev_guide/testing/sanity/replace-urlopen.rst index 310a1b2318..705195c942 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/replace-urlopen.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/replace-urlopen.rst @@ -1,4 +1,4 @@ -Sanity Tests » replace-urlopen -============================== +replace-urlopen +=============== Use ``open_url`` from ``module_utils`` instead of ``urlopen``. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/required-and-default-attributes.rst b/docs/docsite/rst/dev_guide/testing/sanity/required-and-default-attributes.rst index 830465c04a..573c361500 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/required-and-default-attributes.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/required-and-default-attributes.rst @@ -1,5 +1,5 @@ -Sanity Tests » required-and-default-attributes -============================================== +required-and-default-attributes +=============================== Use only one of ``default`` or ``required`` with ``FieldAttribute``. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/rstcheck.rst b/docs/docsite/rst/dev_guide/testing/sanity/rstcheck.rst index f58f5a7139..8fcbbce343 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/rstcheck.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/rstcheck.rst @@ -1,4 +1,4 @@ -Sanity Tests » rstcheck -======================= +rstcheck +======== Check reStructuredText files for syntax and formatting issues. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/sanity-docs.rst b/docs/docsite/rst/dev_guide/testing/sanity/sanity-docs.rst index 7c40f5622e..34265c34be 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/sanity-docs.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/sanity-docs.rst @@ -1,4 +1,4 @@ -Sanity Tests » sanity-docs -========================== +sanity-docs +=========== Documentation for each ``ansible-test sanity`` test is required. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/shebang.rst b/docs/docsite/rst/dev_guide/testing/sanity/shebang.rst index a72389c0a3..cff2aa0914 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/shebang.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/shebang.rst @@ -1,5 +1,5 @@ -Sanity Tests » shebang -====================== +shebang +======= Most executable files should only use one of the following shebangs: diff --git a/docs/docsite/rst/dev_guide/testing/sanity/shellcheck.rst b/docs/docsite/rst/dev_guide/testing/sanity/shellcheck.rst index acd864dc8f..446ee1ee78 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/shellcheck.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/shellcheck.rst @@ -1,4 +1,4 @@ -Sanity Tests » shellcheck -========================= +shellcheck +========== Static code analysis for shell scripts using the excellent `shellcheck `_ tool. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/symlinks.rst b/docs/docsite/rst/dev_guide/testing/sanity/symlinks.rst index 66dbf50068..017209bdd3 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/symlinks.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/symlinks.rst @@ -1,5 +1,5 @@ -Sanity Tests » symlinks -======================= +symlinks +======== Symbolic links are only permitted for files that exist to ensure proper tarball generation during a release. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/test-constraints.rst b/docs/docsite/rst/dev_guide/testing/sanity/test-constraints.rst index 0dcff71c39..0e8789f6c9 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/test-constraints.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/test-constraints.rst @@ -1,4 +1,4 @@ -Sanity Tests » test-constraints -=============================== +test-constraints +================ Constraints for test requirements should be in ``test/runner/requirements/constraints.txt``. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst b/docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst index 3972b9eb14..e06d83dd1a 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/use-argspec-type-path.rst @@ -1,5 +1,5 @@ -Sanity Tests » use-argspec-type-path -==================================== +use-argspec-type-path +===================== The AnsibleModule argument_spec knows of several types beyond the standard python types. One of these is ``path``. When used, type ``path`` ensures that an argument is a string and expands any diff --git a/docs/docsite/rst/dev_guide/testing/sanity/use-compat-six.rst b/docs/docsite/rst/dev_guide/testing/sanity/use-compat-six.rst index 62c3053ac2..1f4150056d 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/use-compat-six.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/use-compat-six.rst @@ -1,4 +1,4 @@ -Sanity Tests » use-compat-six -============================= +use-compat-six +============== Use ``six`` from ``module_utils`` instead of ``six``. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/validate-modules.rst b/docs/docsite/rst/dev_guide/testing/sanity/validate-modules.rst index d08161994e..acf528b622 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/validate-modules.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/validate-modules.rst @@ -1,5 +1,5 @@ -Sanity Tests » validate-modules -=============================== +validate-modules +================ Analyze modules for common issues in code and documentation. diff --git a/docs/docsite/rst/dev_guide/testing/sanity/yamllint.rst b/docs/docsite/rst/dev_guide/testing/sanity/yamllint.rst index 2d3d0ae50a..5822bb7c1e 100644 --- a/docs/docsite/rst/dev_guide/testing/sanity/yamllint.rst +++ b/docs/docsite/rst/dev_guide/testing/sanity/yamllint.rst @@ -1,4 +1,4 @@ -Sanity Tests » yamllint -======================= +yamllint +======== Check YAML files for syntax and formatting issues. -- cgit v1.2.1