Skip to content

Commit bea3856

Browse files
committed
docs: docs/index.rst now pulls from README.rst, about page now pulls project detalis links. Add Crate.io link.
1 parent ea9aa79 commit bea3856

File tree

3 files changed

+34
-57
lines changed

3 files changed

+34
-57
lines changed

README.rst

Lines changed: 25 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,30 @@ tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
2626

2727
Ready to begin? See the `Quickstart`_.
2828

29+
.. _tmuxp on Travis CI: http://travis-ci.org/tony/tmuxp
30+
.. _Documentation: http://tmuxp.rtfd.org/
31+
.. _Source: https://github.com/tony/tmuxp
32+
.. _中文: http://tmuxp-zh.rtfd.org/
33+
.. _tmux(1): http://tmux.sourceforge.net/
34+
.. _tmuxinator: https://github.com/aziz/tmuxinator
35+
.. _teamocil: https://github.com/remiprev/teamocil
36+
.. _Examples: http://tmuxp.readthedocs.org/en/latest/examples.html
37+
.. _freezing live sessions: http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
38+
.. _Importing: http://tmuxp.readthedocs.org/en/latest/cli.html#import
39+
.. _travis.yml: http://tmuxp.readthedocs.org/en/latest/developing.html#travis-ci
40+
.. _testing: http://tmuxp.readthedocs.org/en/latest/developing.html#test-runner
41+
.. _python objects: http://tmuxp.readthedocs.org/en/latest/api.html#api
42+
.. _simple: http://tmuxp.readthedocs.org/en/latest/examples.html#short-hand-inline
43+
.. _very elaborate: http://tmuxp.readthedocs.org/en/latest/examples.html#super-advanced-dev-environment
44+
.. _bash, zsh and tcsh: http://tmuxp.readthedocs.org/en/latest/cli.html#bash-completion
45+
.. _much, much more: http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
46+
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
47+
.. _Internals: http://tmuxp.readthedocs.org/en/latest/internals.html
48+
.. _Commands: http://tmuxp.readthedocs.org/en/latest/cli.html
49+
50+
Project details
51+
---------------
52+
2953
============== ==========================================================
3054
tmux support 1.8, 1.9-dev
3155
python support 2.7, >= 3.3
@@ -37,6 +61,7 @@ Changelog http://tmuxp.readthedocs.org/en/latest/history.html
3761
Issues https://github.com/tony/tmuxp/issues
3862
Source https://github.com/tony/tmuxp
3963
pypi https://pypi.python.org/pypi/tmuxp
64+
Crate.io https://crate.io/packages/tmuxp/
4065
License `BSD`_.
4166
git repo .. code-block:: bash
4267

@@ -56,27 +81,6 @@ tests .. code-block:: bash
5681
$ python ./run_tests.py
5782
============== ==========================================================
5883

59-
.. _tmuxp on Travis CI: http://travis-ci.org/tony/tmuxp
60-
.. _Documentation: http://tmuxp.rtfd.org/
61-
.. _Source: https://github.com/tony/tmuxp
62-
.. _中文: http://tmuxp-zh.rtfd.org/
63-
.. _tmux(1): http://tmux.sourceforge.net/
64-
.. _tmuxinator: https://github.com/aziz/tmuxinator
65-
.. _teamocil: https://github.com/remiprev/teamocil
66-
.. _Examples: http://tmuxp.readthedocs.org/en/latest/examples.html
67-
.. _freezing live sessions: http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
68-
.. _Importing: http://tmuxp.readthedocs.org/en/latest/cli.html#import
69-
.. _travis.yml: http://tmuxp.readthedocs.org/en/latest/developing.html#travis-ci
70-
.. _testing: http://tmuxp.readthedocs.org/en/latest/developing.html#test-runner
71-
.. _python objects: http://tmuxp.readthedocs.org/en/latest/api.html#api
72-
.. _simple: http://tmuxp.readthedocs.org/en/latest/examples.html#short-hand-inline
73-
.. _very elaborate: http://tmuxp.readthedocs.org/en/latest/examples.html#super-advanced-dev-environment
74-
.. _bash, zsh and tcsh: http://tmuxp.readthedocs.org/en/latest/cli.html#bash-completion
75-
.. _much, much more: http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
76-
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
77-
.. _Internals: http://tmuxp.readthedocs.org/en/latest/internals.html
78-
.. _Commands: http://tmuxp.readthedocs.org/en/latest/cli.html
79-
8084
.. _BSD: http://opensource.org/licenses/BSD-3-Clause
8185
.. _developing and testing: http://tmuxp.readthedocs.org/en/latest/developing.html
8286
.. _installing bash completion: http://tmuxp.readthedocs.org/en/latest/quickstart.html#bash-completion

doc/about.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,12 @@ Minor tweaks
9999
- ``$ tmuxp -L<socket-name>``, ``$ tmuxp -S<socket-path>`` for sockets and
100100
``$ tmuxp -f<config-file>`` for config file.
101101

102+
More details
103+
------------
104+
105+
.. include:: ../README.rst
106+
:start-after: ---------------
107+
102108
.. _attempt at 1.7 test: https://travis-ci.org/tony/tmuxp/jobs/12348263
103109
.. _kaptan: https://github.com/emre/kaptan
104110
.. _unittest: http://docs.python.org/2/library/unittest.html

doc/index.rst

Lines changed: 3 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -9,42 +9,9 @@ tmuxp
99
:width: 100%
1010
:align: right
1111

12-
13-
tmuxp, a novel approach to manage `tmux(1)`_ (>= 1.8) workspaces through
14-
`python objects`_.
15-
16-
- Basic support for `freezing live sessions`_.
17-
- `Importing`_ from `teamocil`_ and `tmuxinator`_.
18-
- JSON or YAML for `simple`_ or `very elaborate`_ configurations.
19-
- `bash, zsh and tcsh`_ completion.
20-
- Unit tested against against live tmux (1.8 and git). See `travis.yml`_
21-
file, `tmuxp on Travis CI`_ and `testing`_ page.
22-
- `Documentation`_ (also in `中文`_), `Examples`_, `Source`_,
23-
`Commands`_, `Internals`_.
24-
- and `much, much more`_.
25-
26-
Ready to begin? See the `Quickstart`_.
27-
28-
.. _tmuxp on Travis CI: http://travis-ci.org/tony/tmuxp
29-
.. _Documentation: http://tmuxp.rtfd.org/
30-
.. _Source: https://github.com/tony/tmuxp
31-
.. _中文: http://tmuxp-zh.rtfd.org/
32-
.. _tmux(1): http://tmux.sourceforge.net/
33-
.. _tmuxinator: https://github.com/aziz/tmuxinator
34-
.. _teamocil: https://github.com/remiprev/teamocil
35-
.. _Examples: http://tmuxp.readthedocs.org/en/latest/examples.html
36-
.. _freezing live sessions: http://tmuxp.readthedocs.org/en/latest/cli.html#freeze-sessions
37-
.. _Importing: http://tmuxp.readthedocs.org/en/latest/cli.html#import
38-
.. _travis.yml: http://tmuxp.readthedocs.org/en/latest/developing.html#travis-ci
39-
.. _testing: http://tmuxp.readthedocs.org/en/latest/developing.html#test-runner
40-
.. _python objects: http://tmuxp.readthedocs.org/en/latest/api.html#api
41-
.. _simple: http://tmuxp.readthedocs.org/en/latest/examples.html#short-hand-inline
42-
.. _very elaborate: http://tmuxp.readthedocs.org/en/latest/examples.html#super-advanced-dev-environment
43-
.. _bash, zsh and tcsh: http://tmuxp.readthedocs.org/en/latest/cli.html#bash-completion
44-
.. _much, much more: http://tmuxp.readthedocs.org/en/latest/about.html#minor-tweaks
45-
.. _Quickstart: http://tmuxp.readthedocs.org/en/latest/quickstart.html
46-
.. _Internals: http://tmuxp.readthedocs.org/en/latest/internals.html
47-
.. _Commands: http://tmuxp.readthedocs.org/en/latest/cli.html
12+
.. include:: ../README.rst
13+
:start-line: 13
14+
:end-before: ==============
4815

4916
Explore:
5017

0 commit comments

Comments
 (0)