diff options
| author | Matt Clay <matt@mystile.com> | 2017-04-13 10:28:52 -0700 |
|---|---|---|
| committer | Matt Clay <matt@mystile.com> | 2017-04-13 13:18:53 -0700 |
| commit | 06be3c56a9ba6f6969872d85a6956cacaed55e2a (patch) | |
| tree | 36a51ca87767376499fdfe91587a0b97fafba841 /docs | |
| parent | 92bdd13bb1694fd2a6e33ba32abce972a0bbf3e0 (diff) | |
| download | ansible-06be3c56a9ba6f6969872d85a6956cacaed55e2a.tar.gz | |
Add rstcheck to ansible-test and correct issues. (#23550)
* Add rstcheck to ansible-test.
* Fix rst code-block languages and syntax errors.
* Fix rst inline literals.
* Update python 2 code block to pass tests on py 3.
(cherry picked from commit cb1f57d4e54012ea17f35e17df2462d9c6c14981)
Diffstat (limited to 'docs')
4 files changed, 7 insertions, 7 deletions
diff --git a/docs/docsite/rst/dev_guide/developing_modules_best_practices.rst b/docs/docsite/rst/dev_guide/developing_modules_best_practices.rst index 171559c3d9..9e7e546d65 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_best_practices.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_best_practices.rst @@ -171,7 +171,7 @@ You should never do this in a module: .. code-block:: python - print "some status message" + print("some status message") Because the output is supposed to be valid JSON. diff --git a/docs/docsite/rst/dev_guide/developing_modules_python3.rst b/docs/docsite/rst/dev_guide/developing_modules_python3.rst index 7022aab55d..fad6599b98 100644 --- a/docs/docsite/rst/dev_guide/developing_modules_python3.rst +++ b/docs/docsite/rst/dev_guide/developing_modules_python3.rst @@ -124,6 +124,7 @@ to yield text but instead do the conversion explicitly ourselves. For example:: # Handle the exception gracefully -- usually by displaying a good # user-centric error message that can be traced back to this piece # of code. + pass .. note:: Much of Ansible assumes that all encoded text is UTF-8. At some point, if there is demand for other encodings we may change that, but for @@ -285,7 +286,6 @@ For modules which also run on Python-2.4, we have to use an uglier construction to make this work under both Python-2.4 and Python-3:: from ansible.module_utils.pycompat24 import get_exception - [...] try: a = 2/0 diff --git a/docs/docsite/rst/dev_guide/developing_test_pr.rst b/docs/docsite/rst/dev_guide/developing_test_pr.rst index 361f56402b..f2f843ccdf 100644 --- a/docs/docsite/rst/dev_guide/developing_test_pr.rst +++ b/docs/docsite/rst/dev_guide/developing_test_pr.rst @@ -180,11 +180,11 @@ If the PR does not resolve the issue, or if you see any failures from the unit/i | | When I ran this Ubuntu 16.04 it failed with the following: | - | ``` + | \``` | BLARG | StrackTrace | RRRARRGGG - | ``` + | \``` When you are done testing a feature branch, you can remove it with the following command: diff --git a/docs/docsite/rst/intro_windows.rst b/docs/docsite/rst/intro_windows.rst index be905869a3..7870f6d94b 100644 --- a/docs/docsite/rst/intro_windows.rst +++ b/docs/docsite/rst/intro_windows.rst @@ -107,13 +107,13 @@ Edit your /etc/krb5.conf (which should be installed as a result of installing pa In the section that starts with -.. code-block:: bash +.. code-block:: ini [realms] add the full domain name and the fully qualified domain names of your primary and secondary Active Directory domain controllers. It should look something like this: -.. code-block:: bash +.. code-block:: ini [realms] @@ -125,7 +125,7 @@ add the full domain name and the fully qualified domain names of your primary an and in the [domain_realm] section add a line like the following for each domain you want to access: -.. code-block:: bash +.. code-block:: ini [domain_realm] .my.domain.com = MY.DOMAIN.COM |