archive
/
mitogen
mirror of https://github.com/mitogen-hq/mitogen.git
1
0
Fork 0
Code Releases Activity

issue #388: fix Sphinx markup

Browse Source
issue260
David Wilson 6 years ago
parent 5eff8ea4fb
commit 8e4c164d93
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File

25
docs/api.rst
Unescape Escape View File

@ -107,7 +107,8 @@ Router Class
Connection Methods Connection Methods
================== ==================
.. method:: mitogen.parent.Router.fork (on_fork=None, on_start=None, debug=False, profiling=False, via=None) .. currentmodule:: mitogen.parent
.. method:: Router.fork (on_fork=None, on_start=None, debug=False, profiling=False, via=None)
Construct a context on the local machine by forking the current Construct a context on the local machine by forking the current
process. The forked child receives a new identity, sets up a new broker process. The forked child receives a new identity, sets up a new broker
@ -203,7 +204,7 @@ Connection Methods
:param bool profiling: :param bool profiling:
Same as the `profiling` parameter for :meth:`local`. Same as the `profiling` parameter for :meth:`local`.
.. method:: mitogen.parent.Router.local (remote_name=None, python_path=None, debug=False, connect_timeout=None, profiling=False, via=None) .. method:: Router.local (remote_name=None, python_path=None, debug=False, connect_timeout=None, profiling=False, via=None)
Construct a context on the local machine as a subprocess of the current Construct a context on the local machine as a subprocess of the current
process. The associated stream implementation is process. The associated stream implementation is
@ -264,7 +265,7 @@ Connection Methods
# Use the SSH connection to create a sudo connection. # Use the SSH connection to create a sudo connection.
remote_root = router.sudo(username='root', via=remote_machine) remote_root = router.sudo(username='root', via=remote_machine)
.. method:: mitogen.parent.Router.doas (username=None, password=None, doas_path=None, password_prompt=None, incorrect_prompts=None, \**kwargs) .. method:: Router.doas (username=None, password=None, doas_path=None, password_prompt=None, incorrect_prompts=None, \**kwargs)
Construct a context on the local machine over a ``doas`` invocation. Construct a context on the local machine over a ``doas`` invocation.
The ``doas`` process is started in a newly allocated pseudo-terminal, The ``doas`` process is started in a newly allocated pseudo-terminal,
@ -289,7 +290,7 @@ Connection Methods
A password was requested but none was provided, the supplied A password was requested but none was provided, the supplied
password was incorrect, or the target account did not exist. password was incorrect, or the target account did not exist.
.. method:: mitogen.parent.Router.docker (container=None, image=None, docker_path=None, \**kwargs) .. method:: Router.docker (container=None, image=None, docker_path=None, \**kwargs)
Construct a context on the local machine within an existing or Construct a context on the local machine within an existing or
temporary new Docker container using the ``docker`` program. One of temporary new Docker container using the ``docker`` program. One of
@ -309,7 +310,7 @@ Connection Methods
Filename or complete path to the Docker binary. ``PATH`` will be Filename or complete path to the Docker binary. ``PATH`` will be
searched if given as a filename. Defaults to ``docker``. searched if given as a filename. Defaults to ``docker``.
.. method:: mitogen.parent.Router.jail (container, jexec_path=None, \**kwargs) .. method:: Router.jail (container, jexec_path=None, \**kwargs)
Construct a context on the local machine within a FreeBSD jail using Construct a context on the local machine within a FreeBSD jail using
the ``jexec`` program. the ``jexec`` program.
@ -325,7 +326,7 @@ Connection Methods
Filename or complete path to the ``jexec`` binary. ``PATH`` will be Filename or complete path to the ``jexec`` binary. ``PATH`` will be
searched if given as a filename. Defaults to ``/usr/sbin/jexec``. searched if given as a filename. Defaults to ``/usr/sbin/jexec``.
.. method:: mitogen.parent.Router.kubectl (pod, kubectl_path=None, kubectl_args=None, \**kwargs) .. method:: Router.kubectl (pod, kubectl_path=None, kubectl_args=None, \**kwargs)
Construct a context in a container via the Kubernetes ``kubectl`` Construct a context in a container via the Kubernetes ``kubectl``
program. program.
@ -340,7 +341,7 @@ Connection Methods
:param list kubectl_args: :param list kubectl_args:
Additional arguments to pass to the ``kubectl`` command. Additional arguments to pass to the ``kubectl`` command.
.. method:: mitogen.parent.Router.lxc (container, lxc_attach_path=None, \**kwargs) .. method:: Router.lxc (container, lxc_attach_path=None, \**kwargs)
Construct a context on the local machine within an LXC classic Construct a context on the local machine within an LXC classic
container using the ``lxc-attach`` program. container using the ``lxc-attach`` program.
@ -354,7 +355,7 @@ Connection Methods
will be searched if given as a filename. Defaults to will be searched if given as a filename. Defaults to
``lxc-attach``. ``lxc-attach``.
.. method:: mitogen.parent.Router.lxc (container, lxc_attach_path=None, \**kwargs) .. method:: Router.lxc (container, lxc_attach_path=None, \**kwargs)
Construct a context on the local machine within a LXD container using Construct a context on the local machine within a LXD container using
the ``lxc`` program. the ``lxc`` program.
@ -367,7 +368,7 @@ Connection Methods
Filename or complete path to the ``lxc`` binary. ``PATH`` will be Filename or complete path to the ``lxc`` binary. ``PATH`` will be
searched if given as a filename. Defaults to ``lxc``. searched if given as a filename. Defaults to ``lxc``.
.. method:: mitogen.parent.Router.setns (container, kind, username=None, docker_path=None, lxc_info_path=None, machinectl_path=None, \**kwargs) .. method:: Router.setns (container, kind, username=None, docker_path=None, lxc_info_path=None, machinectl_path=None, \**kwargs)
Construct a context in the style of :meth:`local`, but change the Construct a context in the style of :meth:`local`, but change the
active Linux process namespaces via calls to `setns(1)` before active Linux process namespaces via calls to `setns(1)` before
@ -401,7 +402,7 @@ Connection Methods
will be searched if given as a filename. Defaults to will be searched if given as a filename. Defaults to
``machinectl``. ``machinectl``.
.. method:: mitogen.parent.Router.su (username=None, password=None, su_path=None, password_prompt=None, incorrect_prompts=None, \**kwargs) .. method:: Router.su (username=None, password=None, su_path=None, password_prompt=None, incorrect_prompts=None, \**kwargs)
Construct a context on the local machine over a ``su`` invocation. The Construct a context on the local machine over a ``su`` invocation. The
``su`` process is started in a newly allocated pseudo-terminal, and ``su`` process is started in a newly allocated pseudo-terminal, and
@ -428,7 +429,7 @@ Connection Methods
password was incorrect, or (on BSD) the target account did not password was incorrect, or (on BSD) the target account did not
exist. exist.
.. method:: mitogen.parent.Router.sudo (username=None, sudo_path=None, password=None, \**kwargs) .. method:: Router.sudo (username=None, sudo_path=None, password=None, \**kwargs)
Construct a context on the local machine over a ``sudo`` invocation. Construct a context on the local machine over a ``sudo`` invocation.
The ``sudo`` process is started in a newly allocated pseudo-terminal, The ``sudo`` process is started in a newly allocated pseudo-terminal,
@ -464,7 +465,7 @@ Connection Methods
:class:`mitogen.core.StreamError` to be raised, and that :class:`mitogen.core.StreamError` to be raised, and that
attributes of the stream match the actual behaviour of ``sudo``. attributes of the stream match the actual behaviour of ``sudo``.
.. method:: mitogen.parent.Router.ssh (hostname, username=None, ssh_path=None, ssh_args=None, port=None, check_host_keys='enforce', password=None, identity_file=None, identities_only=True, compression=True, \**kwargs) .. method:: Router.ssh (hostname, username=None, ssh_path=None, ssh_args=None, port=None, check_host_keys='enforce', password=None, identity_file=None, identities_only=True, compression=True, \**kwargs)
Construct a remote context over an OpenSSH ``ssh`` invocation. Construct a remote context over an OpenSSH ``ssh`` invocation.

3
mitogen/master.py
Unescape Escape View File

@ -815,9 +815,8 @@ class Router(mitogen.parent.Router):
#: main threads existing in any child to write #: main threads existing in any child to write
#: ``/tmp/mitogen.stats.<pid>.<thread_name>.log`` containing a #: ``/tmp/mitogen.stats.<pid>.<thread_name>.log`` containing a
#: :mod:`cProfile` dump on graceful exit. Must be set prior to construction #: :mod:`cProfile` dump on graceful exit. Must be set prior to construction
#: of any :class:`Broker`, e.g. via: #: of any :class:`Broker`, e.g. via::
#: #:
#: .. code::
#: mitogen.master.Router.profiling = True #: mitogen.master.Router.profiling = True
profiling = False profiling = False

Write Preview
Loading…
Cancel
Save