diff --git a/docs/ansible_detailed.rst b/docs/ansible_detailed.rst index 64fcd636..a95575ee 100644 --- a/docs/ansible_detailed.rst +++ b/docs/ansible_detailed.rst @@ -147,8 +147,10 @@ Noteworthy Differences * Mitogen 0.2.x supports Ansible 2.3-2.9; with Python 2.6, 2.7, or 3.6. Mitogen 0.3.1+ supports + - Ansible 2.10, 3, and 4; with Python 2.7, or 3.6-3.11 - Ansible 5 and 6; with Python 3.8-3.11 + Verify your installation is running one of these versions by checking ``ansible --version`` output. diff --git a/docs/changelog.rst b/docs/changelog.rst index d4060177..dde66319 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -92,7 +92,7 @@ v0.2.10 (2021-11-24) * :gh:issue:`756` ssh connections with `check_host_keys='accept'` would timeout, when using recent OpenSSH client versions. * :gh:issue:`758` fix initilialisation of callback plugins in test suite, to address a `KeyError` in - :method:`ansible.plugins.callback.CallbackBase.v2_runner_on_start` + :py:meth:`ansible.plugins.callback.CallbackBase.v2_runner_on_start` * :gh:issue:`775` Test with Python 3.9 * :gh:issue:`775` Add msvcrt to the default module deny list diff --git a/docs/conf.py b/docs/conf.py index 54e3a5c7..80607694 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,10 +1,9 @@ -import os import sys sys.path.append('..') sys.path.append('.') import mitogen -VERSION = '%s.%s.%s' % mitogen.__version__ +VERSION = '.'.join(str(part) for part in mitogen.__version__) author = u'Network Genomics' copyright = u'2021, the Mitogen authors' diff --git a/docs/requirements.txt b/docs/requirements.txt index 3c4674fd..a2894c82 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,3 +1,6 @@ +docutils<0.18 +Jinja2<3 +MarkupSafe<2.1 Sphinx==2.1.2; python_version > '3.0' sphinxcontrib-programoutput==0.14; python_version > '3.0' alabaster==0.7.10; python_version > '3.0' diff --git a/mitogen/service.py b/mitogen/service.py index 0e5f6419..7fde9013 100644 --- a/mitogen/service.py +++ b/mitogen/service.py @@ -752,10 +752,12 @@ class PushFileService(Service): One size fits all method to ensure a target context has been preloaded with a set of small files and Python modules. - overridden_sources: optional dict containing source code to override path's source code - extra_sys_paths: loads additional sys paths for use in finding modules; beneficial - in situations like loading Ansible Collections because source code - dependencies come from different file paths than where the source lives + :param dict overridden_sources: + Optional dict containing source code to override path's source code + :param extra_sys_paths: + Loads additional sys paths for use in finding modules; beneficial + in situations like loading Ansible Collections because source code + dependencies come from different file paths than where the source lives """ for path in paths: overridden_source = None diff --git a/tox.ini b/tox.ini index 5bfb7fe9..e4c26c39 100644 --- a/tox.ini +++ b/tox.ini @@ -139,7 +139,9 @@ whitelist_externals = echo [testenv:docs] -basepython = python3 +basepython = python3.8 changedir = docs commands = sphinx-build -W -b html -d {envtmpdir}/doctrees . {envtmpdir}/html +deps = + -r docs/requirements.txt