summaryrefslogtreecommitdiffstats
path: root/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/docsite/rst/dev_guide/testing/sanity/pep8.rst')
-rw-r--r--docs/docsite/rst/dev_guide/testing/sanity/pep8.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst b/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst
new file mode 100644
index 0000000..9424bda
--- /dev/null
+++ b/docs/docsite/rst/dev_guide/testing/sanity/pep8.rst
@@ -0,0 +1,24 @@
+.. _testing_pep8:
+
+pep8
+====
+
+Python static analysis for PEP 8 style guideline compliance.
+
+`PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default.
+
+Running locally
+-----------------
+
+The `PEP 8`_ check can be run locally as follows:
+
+.. code-block:: shell
+
+ ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...
+
+
+
+.. _PEP 8: https://www.python.org/dev/peps/pep-0008/
+.. _pycodestyle: https://pypi.org/project/pycodestyle/
+
+