ansible/docs/docsite/rst/dev_guide/testing_pep8.rst

:orphan:

.. _testing_pep8:

*****
PEP 8
*****

.. contents:: Topics

`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 with::


    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/
Remove more docs build errors (#45364) * orphans testing pages to avoid not-in-toctree errors * orphans various pages pending reorg * adds module_utils and special_vars to main TOC * uses a glob for scenario_guide TOC * normalize and Sentence-case headings on community pages, typos * re-orgs community TOC, adds all pages to toctree * removes scenario guides index page * adds style guide to community index * basic update to style guide * fix typo that created a new error * removes not-in-toctree from ignore errors list * leave removing files for future cleanup task 2018-09-11 11:51:47 -05:00			`:orphan:`

rewrite of the developer guide, part 1 (#45179) * rewrite of the developer guide, part 1 2018-09-07 08:57:36 -05:00			`.. _testing_pep8:`

Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 09:08:26 +01:00			`*****`
			`PEP 8`
			`*****`

			`.. contents:: Topics`

Use pycodestyle instead of pep8 (#25947) 2017-07-13 20:46:31 +02:00			`PEP 8`_ style guidelines are enforced by `pycodestyle`_ on all python files in the repository by default.
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 09:08:26 +01:00
			`Running Locally`
			`===============`

Use pycodestyle instead of pep8 (#25947) 2017-07-13 20:46:31 +02:00			The `PEP 8`_ check can be run locally with::
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 09:08:26 +01:00

Remove obsolete docs on pep8 sanity test. 2019-08-01 22:25:11 -07:00			`ansible-test sanity --test pep8 [file-or-directory-path-to-check] ...`
Docs how to test (2nd) (#24094) * Big testing doc refactor * Combine all the testing documentation in to one place to make it easier to find * Convert everything to RST * Create testing_network guide * Create testing landing page * For each section detail "how to run" and "how to extend testing" * More examples * Lots more detail 2017-04-28 09:08:26 +01:00


			`.. _PEP 8: https://www.python.org/dev/peps/pep-0008/`
Update all pypi.python.org URLs to pypi.org (#38988) For details on the new PyPI, see the blog post: https://pythoninsider.blogspot.ca/2018/04/new-pypi-launched-legacy-pypi-shutting.html 2018-05-14 15:41:47 -07:00			`.. _pycodestyle: https://pypi.org/project/pycodestyle/`