Remove redundant "Sanity Tests »" from page title.

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 b4494fa547)
pull/59657/head
Matt Clay 6 years ago
parent 4782c6b0b8
commit dd42aac878

@ -1,4 +1,4 @@
Sanity Tests » action-plugin-docs action-plugin-docs
================================= ==================
Each action plugin should have a matching module of the same name to provide documentation. Each action plugin should have a matching module of the same name to provide documentation.

@ -1,4 +1,4 @@
Sanity Tests » ansible-doc ansible-doc
========================== ===========
Verifies that ``ansible-doc`` can parse module documentation on all supported Python versions. Verifies that ``ansible-doc`` can parse module documentation on all supported Python versions.

@ -1,6 +1,6 @@
:orphan: :orphan:
Sanity Tests » ansible-var-precedence-check ansible-var-precedence-check
=========================================== ============================
Check the order of precedence for Ansible variables against :ref:`ansible_variable_precedence`. Check the order of precedence for Ansible variables against :ref:`ansible_variable_precedence`.

@ -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: Update the Azure integration test requirements file when changes are made to the Azure packaging requirements file:

@ -1,5 +1,7 @@
Sanity Tests » boilerplate :orphan:
==========================
boilerplate
===========
Most Python files should include the following boilerplate: Most Python files should include the following boilerplate:

@ -1,4 +1,4 @@
Sanity Tests » botmeta botmeta
====================== =======
Verifies that ``./github/BOTMETA.yml`` is valid. Verifies that ``./github/BOTMETA.yml`` is valid.

@ -1,5 +1,5 @@
Sanity Tests » changelog changelog
======================== =========
Basic linting of changelog fragments with yamllint and rstcheck. Basic linting of changelog fragments with yamllint and rstcheck.

@ -1,4 +1,4 @@
Sanity Tests » compile compile
====================== =======
See :doc:`../../testing_compile` for more information. See :doc:`../../testing_compile` for more information.

@ -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. 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. It is used by external automated processes and cannot be moved, renamed or replaced with a symbolic link.

@ -1,6 +1,6 @@
:orphan: :orphan:
Sanity Tests » deprecated-config deprecated-config
================================ =================
``DOCUMENTATION`` config is scheduled for removal ``DOCUMENTATION`` config is scheduled for removal

@ -1,4 +1,4 @@
Sanity Tests » docs-build docs-build
========================= ==========
Verifies that ``make singlehtmldocs`` in ``docs/docsite/`` completes without errors. Verifies that ``make singlehtmldocs`` in ``docs/docsite/`` completes without errors.

@ -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 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 and tests), ``__init__.py`` files with code won't be used. For others (module_utils), we want the

@ -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 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. must be imported in a try/except ImportError block.

@ -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/``. 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. Each test MUST have an ``aliases`` file to control test execution.

@ -1,4 +1,4 @@
Sanity Tests » line-endings line-endings
=========================== ============
All files must use ``\n`` for line endings instead of ``\r\n``. All files must use ``\n`` for line endings instead of ``\r\n``.

@ -1,5 +1,5 @@
Sanity Tests » no-assert no-assert
======================== =========
Do not use ``assert`` in production Ansible python code. When running Python Do not use ``assert`` in production Ansible python code. When running Python
with optimizations, Python will remove ``assert`` statements, potentially with optimizations, Python will remove ``assert`` statements, potentially

@ -1,5 +1,5 @@
Sanity Tests » no-basestring no-basestring
============================ =============
Do not use ``isinstance(s, basestring)`` as basestring has been removed in Do not use ``isinstance(s, basestring)`` as basestring has been removed in
Python3. You can import ``string_types``, ``binary_type``, or ``text_type`` Python3. You can import ``string_types``, ``binary_type``, or ``text_type``

@ -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: The ``dict.iteritems`` method has been removed in Python 3. There are two recommended alternatives:

@ -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: The ``dict.iterkeys`` method has been removed in Python 3. Use the following instead:

@ -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: The ``dict.itervalues`` method has been removed in Python 3. There are two recommended alternatives:

@ -1,5 +1,5 @@
Sanity Tests » no-get-exception no-get-exception
=============================== ================
We created a function, ``ansible.module_utils.pycompat24.get_exception`` to We created a function, ``ansible.module_utils.pycompat24.get_exception`` to
help retrieve exceptions in a manner compatible with Python 2.4 through help retrieve exceptions in a manner compatible with Python 2.4 through

@ -1,5 +1,5 @@
Sanity Tests » no-illegal-filenames no-illegal-filenames
=================================== ====================
Files and directories should not contain illegal characters or names so that Files and directories should not contain illegal characters or names so that
Ansible can be checked out on any Operating System. Ansible can be checked out on any Operating System.

@ -1,5 +1,5 @@
Sanity Tests » no-main-display no-main-display
============================== ===============
As of Ansible 2.8, ``Display`` should no longer be imported from ``__main__``. As of Ansible 2.8, ``Display`` should no longer be imported from ``__main__``.

@ -1,4 +1,4 @@
Sanity Tests » no-smart-quotes no-smart-quotes
============================== ===============
Smart quotes (``”“‘’``) should not be used. Use plain ascii quotes (``"'``) instead. Smart quotes (``”“‘’``) should not be used. Use plain ascii quotes (``"'``) instead.

@ -1,5 +1,7 @@
Sanity Tests » no-tests-as-filters :orphan:
==================================
no-tests-as-filters
===================
Using Ansible provided Jinja2 tests as filters will be removed in Ansible 2.9. Using Ansible provided Jinja2 tests as filters will be removed in Ansible 2.9.

@ -1,7 +1,7 @@
:orphan: :orphan:
Sanity Tests » no-underscore-variable no-underscore-variable
===================================== ======================
In the future, Ansible may use the identifier ``_`` to internationalize its 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 message strings. To be ready for that, we need to make sure that there are

@ -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 The use of :code:`from __future__ import unicode_literals` has been deemed an anti-pattern. The
problems with it are: problems with it are:

@ -1,7 +1,7 @@
:orphan: :orphan:
Sanity Tests » no-wildcard-import no-wildcard-import
================================= ==================
Using :code:`import *` is a bad habit which pollutes your namespace, hinders Using :code:`import *` is a bad habit which pollutes your namespace, hinders
debugging, and interferes with static analysis of code. For those reasons, we debugging, and interferes with static analysis of code. For those reasons, we

@ -1,5 +1,5 @@
Sanity Tests » pep8 pep8
=================== ====
Python static analysis for PEP 8 style guideline compliance. Python static analysis for PEP 8 style guideline compliance.

@ -1,4 +1,4 @@
Sanity Tests » pslint pslint
===================== ======
PowerShell static analysis for common programming errors using `PSScriptAnalyzer <https://github.com/PowerShell/PSScriptAnalyzer/>`_. PowerShell static analysis for common programming errors using `PSScriptAnalyzer <https://github.com/PowerShell/PSScriptAnalyzer/>`_.

@ -1,7 +1,7 @@
:orphan: :orphan:
Sanity Tests » pylint-ansible-test pylint-ansible-test
================================== ===================
Python static analysis for common programming errors. Python static analysis for common programming errors.

@ -1,4 +1,4 @@
Sanity Tests » pylint pylint
===================== ======
Python static analysis for common programming errors. Python static analysis for common programming errors.

@ -1,4 +1,4 @@
Sanity Tests » replace-urlopen replace-urlopen
============================== ===============
Use ``open_url`` from ``module_utils`` instead of ``urlopen``. Use ``open_url`` from ``module_utils`` instead of ``urlopen``.

@ -1,5 +1,5 @@
Sanity Tests » required-and-default-attributes required-and-default-attributes
============================================== ===============================
Use only one of ``default`` or ``required`` with ``FieldAttribute``. Use only one of ``default`` or ``required`` with ``FieldAttribute``.

@ -1,4 +1,4 @@
Sanity Tests » rstcheck rstcheck
======================= ========
Check reStructuredText files for syntax and formatting issues. Check reStructuredText files for syntax and formatting issues.

@ -1,4 +1,4 @@
Sanity Tests » sanity-docs sanity-docs
========================== ===========
Documentation for each ``ansible-test sanity`` test is required. Documentation for each ``ansible-test sanity`` test is required.

@ -1,5 +1,5 @@
Sanity Tests » shebang shebang
====================== =======
Most executable files should only use one of the following shebangs: Most executable files should only use one of the following shebangs:

@ -1,4 +1,4 @@
Sanity Tests » shellcheck shellcheck
========================= ==========
Static code analysis for shell scripts using the excellent `shellcheck <https://www.shellcheck.net/>`_ tool. Static code analysis for shell scripts using the excellent `shellcheck <https://www.shellcheck.net/>`_ tool.

@ -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. Symbolic links are only permitted for files that exist to ensure proper tarball generation during a release.

@ -1,4 +1,4 @@
Sanity Tests » test-constraints test-constraints
=============================== ================
Constraints for test requirements should be in ``test/runner/requirements/constraints.txt``. Constraints for test requirements should be in ``test/runner/requirements/constraints.txt``.

@ -1,7 +1,7 @@
:orphan: :orphan:
Sanity Tests » update-bundled update-bundled
============================= ==============
Check whether any of our known bundled code needs to be updated for a new upstream release. Check whether any of our known bundled code needs to be updated for a new upstream release.

@ -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 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 these is ``path``. When used, type ``path`` ensures that an argument is a string and expands any

@ -1,4 +1,4 @@
Sanity Tests » use-compat-six use-compat-six
============================= ==============
Use ``six`` from ``module_utils`` instead of ``six``. Use ``six`` from ``module_utils`` instead of ``six``.

@ -1,5 +1,5 @@
Sanity Tests » validate-modules validate-modules
=============================== ================
Analyze modules for common issues in code and documentation. Analyze modules for common issues in code and documentation.

@ -1,4 +1,4 @@
Sanity Tests » yamllint yamllint
======================= ========
Check YAML files for syntax and formatting issues. Check YAML files for syntax and formatting issues.

Loading…
Cancel
Save