tweaks to api docs / interlinking fixes

Author: tony

libtmux/common.py

@@ -156,7 +156,7 @@ class tmux_cmd(object):
 
         $ tmux new-session -s my session
 
-    :versionchanged: 0.8
+    .. versionchanged:: 0.8
         Renamed from ``tmux`` to ``tmux_cmd``.
 
     """
@@ -298,7 +298,7 @@ class TmuxRelationalObject(object):
     def find_where(self, attrs):
         """Return object on first match.
 
-        :versionchanged: 0.4
+        .. versionchanged:: 0.4
             Renamed from ``.findWhere`` to ``.find_where``.
 
         """
@@ -498,9 +498,10 @@ def has_minimum_version(raises=True):
     :returns: True if tmux meets minimum required version
     :rtype: bool
 
-    :versionchanged: 0.7.0
+    .. versionchanged:: 0.7.0
         No longer returns version, returns True or False
-    :versionchanged: 0.1.7
+
+    .. versionchanged:: 0.1.7
         Versions will now remove trailing letters per `Issue 55`_.
 
         .. _Issue 55: https://github.com/tony/tmuxp/issues/55.
@@ -557,7 +558,7 @@ def handle_option_error(error):
     :param error: error response from subprocess call
     :type error: str
     :raises: :exc:`exc.OptionError`, :exc:`exc.UnknownOption`,
-        :exc:`exc.InvalidOption`, :exc:`excAmbiguousOption`
+        :exc:`exc.InvalidOption`, :exc:`exc.AmbiguousOption`
     """
     if 'unknown option' in error:
         raise exc.UnknownOption(error)

libtmux/pane.py

@@ -21,10 +21,10 @@ class Pane(TmuxMappingObject, TmuxRelationalObject):
 
     :param window: :class:`Window`
 
-    :versionchanged: 0.8
+    .. versionchanged:: 0.8
         Renamed from ``.tmux`` to ``.cmd``.
     """
-    #: namespace used :class:`TmuxMappingObject`
+    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = 'pane_'
 
     def __init__(self, window=None, **kwargs):

libtmux/server.py

@@ -42,9 +42,9 @@ class Server(TmuxRelationalObject, EnvironmentMixin):
     config_file = None
     #: ``-2`` or ``-8``
     colors = None
-    #: unique child ID key used by :class:`TmuxRelationalObject`
+    #: unique child ID used by :class:`~libtmux.common.TmuxRelationalObject`
     child_id_attribute = 'session_id'
-    #: namespace used :class:`TmuxMappingObject`
+    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = 'server_'
 
     def __init__(
@@ -72,11 +72,11 @@ def __init__(
             self.colors = colors
 
     def cmd(self, *args, **kwargs):
-        """Return :class:`util.tmux_cmd` send tmux commands with sockets, colors.
+        """Execute tmux command and return output.
 
-        :rtype: :class:`util.tmux_cmd`
+        :rtype: :class:`common.tmux_cmd`
 
-        :versionchanged: 0.8
+        .. versionchanged:: 0.8
             Renamed from ``.tmux`` to ``.cmd``.
 
         """
@@ -103,8 +103,8 @@ def _list_sessions(self):
 
         Retrieved from ``$ tmux(1) list-sessions`` stdout.
 
-        The :py:obj:`list` is derived from ``stdout`` in :class:`util.tmux_cmd`
-        which wraps :py:class:`subprocess.Popen`.
+        The :py:obj:`list` is derived from ``stdout`` in
+        :class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
 
         :rtype: :py:obj:`list` of :py:obj:`dict`
 
@@ -161,16 +161,16 @@ def list_sessions(self):
     def sessions(self):
         """Property / alias to return :meth:`~.list_sessions`."""
         return self.list_sessions()
-    #: Alias of :attr:`sessions`, , used by :class:`TmuxRelationalObject`
+    #: Alias :attr:`sessions` for :class:`~libtmux.common.TmuxRelationalObject`
     children = sessions
 
     def _list_windows(self):
         """Return list of windows in :py:obj:`dict` form.
 
         Retrieved from ``$ tmux(1) list-windows`` stdout.
 
-        The :py:obj:`list` is derived from ``stdout`` in :class:`util.tmux_cmd`
-        which wraps :py:class:`subprocess.Popen`.
+        The :py:obj:`list` is derived from ``stdout`` in
+        :class:`common.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
 
         :rtype: list
 
@@ -227,8 +227,8 @@ def _list_panes(self):
 
         Retrieved from ``$ tmux(1) list-panes`` stdout.
 
-        The :py:obj:`list` is derived from ``stdout`` in :class:`util.tmux_cmd`
-        which wraps :py:class:`subprocess.Popen`.
+        The :py:obj:`list` is derived from ``stdout`` in
+        :class:`util.tmux_cmd` which wraps :py:class:`subprocess.Popen`.
 
         :rtype: list
 

libtmux/session.py

@@ -28,9 +28,9 @@ class Session(
     Holds :class:`Window` objects.
     """
 
-    #: unique child ID key used by :class:`TmuxRelationalObject`
+    #: unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`
     child_id_attribute = 'window_id'
-    #: namespace used :class:`TmuxMappingObject`
+    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = 'session_'
 
     def __init__(self, server=None, **kwargs):
@@ -68,7 +68,7 @@ def cmd(self, *args, **kwargs):
 
         :rtype: :class:`server.cmd`
 
-        :versionchanged: 0.8
+        .. versionchanged:: 0.8
             Renamed from ``.tmux`` to ``.cmd``.
 
         """
@@ -261,7 +261,7 @@ def windows(self):
         """Property / alias to return :meth:`Session.list_windows`."""
         return self.list_windows()
 
-    #: Alias of :attr:`windows`, used by :class:`TmuxRelationalObject`
+    #: Alias :attr:`windows` for :class:`~libtmux.common.TmuxRelationalObject`
     children = windows
 
     @property

libtmux/window.py

@@ -23,9 +23,9 @@
 class Window(TmuxMappingObject, TmuxRelationalObject):
     """:term:`tmux(1)` window."""
 
-    #: unique child ID key used by :class:`TmuxRelationalObject`
+    #: unique child ID key for :class:`~libtmux.common.TmuxRelationalObject`
     child_id_attribute = 'pane_id'
-    #: namespace used :class:`TmuxMappingObject`
+    #: namespace used :class:`~libtmux.common.TmuxMappingObject`
     formatter_prefix = 'window_'
 
     def __init__(self, session=None, **kwargs):
@@ -85,7 +85,7 @@ def cmd(self, cmd, *args, **kwargs):
 
         :rtype: :class:`Server.cmd`
 
-        :versionchanged: 0.8
+        .. versionchanged:: 0.8
             Renamed from ``.tmux`` to ``.cmd``.
 
         """
@@ -478,5 +478,5 @@ def panes(self):
         """Property / alias to return :meth:`~.list_panes`."""
         return self.list_panes()
 
-    #: Alias of :attr:`panes`, used by :class:`TmuxRelationalObject`
+    #: Alias :attr:`panes` for :class:`~libtmux.common.TmuxRelationalObject`
     children = panes