Skip to content

Commit a6d9d35

Browse files
committed
Correct libtmux intersphinx conf and links, rm libtmux pages
1 parent 71ffa51 commit a6d9d35

File tree

5 files changed

+14
-507
lines changed

5 files changed

+14
-507
lines changed

doc/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,8 @@
286286

287287
# Example configuration for intersphinx: refer to the Python standard library.
288288
intersphinx_mapping = {
289-
'http://docs.python.org/': None,
290-
'https://tmuxp.readthedocs.org/en/latest/': None
289+
'python': ('http://docs.python.org/', None),
290+
'libtmux': ('https://libtmux.readthedocs.org/', None)
291291
}
292292

293293
# aafig format, try to get working with pdf

doc/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Explore:
2323
quickstart
2424
examples
2525
cli
26-
internals
2726
developing
2827
api
2928
history

doc/internals.rst

Lines changed: 0 additions & 97 deletions
This file was deleted.

doc/quickstart.rst

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,9 @@ Then install :ref:`bash_completion`.
2424
Known issue on RHEL/CentOS/Fedora
2525
---------------------------------
2626

27-
For all RedHat-based distros there might be an issue with starting tmuxp.
27+
For all RedHat-based distros there might be an issue with starting tmuxp.
28+
29+
.. code-block:: sh
2830
2931
$ tmuxp
3032
Traceback (most recent call last):
@@ -83,7 +85,7 @@ Pythonics
8385
---------
8486

8587
.. seealso::
86-
:ref:`tmuxp python API documentation <api>` and :ref:`developing`,
88+
:ref:`libtmux python API documentation <libtmux:api>` and :ref:`developing`,
8789
:ref:`internals`.
8890

8991

@@ -97,35 +99,14 @@ AL - `Abstraction Layer`_
9799
python abstraction layer
98100
""""""""""""""""""""""""
99101

100-
.. module:: tmuxp
101-
102102
======================================== =================================
103-
:ref:`tmuxp python api <api>` :term:`tmux(1)` equivalent
103+
:ref:`tmuxp python api <libtmux:api>` :term:`tmux(1)` equivalent
104104
======================================== =================================
105-
:class:`Server.new_session()` ``$ tmux new-session``
106-
:class:`Server.list_sessions()` ``$ tmux list-sessions``
107-
:class:`Session.list_windows()` ``$ tmux list-windows``
108-
:class:`Session.new_window()` ``$ tmux new-window``
109-
:class:`Window.list_panes()` ``$ tmux list-panes``
110-
:class:`Window.split_window()` ``$ tmux split-window``
111-
:class:`Pane.send_keys()` ``$ tmux send-keys``
105+
:meth:`libtmux.Server.new_session` ``$ tmux new-session``
106+
:meth:`libtmux.Server.list_sessions` ``$ tmux list-sessions``
107+
:meth:`libtmux.Session.list_windows` ``$ tmux list-windows``
108+
:meth:`libtmux.Session.new_window` ``$ tmux new-window``
109+
:meth:`libtmux.Window.list_panes` ``$ tmux list-panes``
110+
:meth:`libtmux.Window.split_window` ``$ tmux split-window``
111+
:meth:`libtmux.Pane.send_keys` ``$ tmux send-keys``
112112
======================================== =================================
113-
114-
tmux ORM
115-
""""""""
116-
117-
tmuxp's core internal feature is the object relation and orchestration of
118-
the tmux server (think an `engine`_ in `SQLAlchemy`_) and the server's
119-
sessions, so on...
120-
121-
- :class:`Server` holds :class:`Session` objects.
122-
- :class:`Session` holds :class:`Window` objects.
123-
- :class:`Window` holds :class:`Pane` objects.
124-
125-
instances of tmux objects use tmux `1.8`_'s ``pane_id``, ``window_id`` and
126-
``session_id`` to build create python objects to build workspaces with the
127-
freshest data.
128-
129-
.. _engine: http://docs.sqlalchemy.org/en/rel_0_8/core/engines.html
130-
.. _sqlalchemy: http://www.sqlalchemy.org/
131-
.. _1.8: http://sourceforge.net/projects/tmux/files/tmux/tmux-1.8/

0 commit comments

Comments
 (0)