start to document commands, try sphinx-argparse

Author: tony

doc/about.rst

@@ -18,6 +18,15 @@ Interested in some kung-fu or joining the effort? :ref:`api` and
 License  is `BSD-licensed`_. Code can be found at github at
 http://github.com/tony/tmuxp.
 
+How is tmuxp different from teamocil and tmuxinator
+---------------------------------------------------
+
+teamocil and tmuxinator both build tmux workspaces from yaml. tmuxp
+also handles building workspaces.
+
+teamocil and tmuxinator do this by turning YAML directly into tmux
+commands.
+
 .. _attempt at 1.7 test: https://travis-ci.org/tony/tmuxp/jobs/12348263
 .. _kaptan: https://github.com/emre/kaptan
 .. _unittest: http://docs.python.org/2/library/unittest.html

doc/conf.py

@@ -33,6 +33,7 @@
               'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
               'sphinxcontrib.aafig',
+              'sphinxarg.ext',
               ]
 
 # Add any paths that contain templates here, relative to this directory.

doc/quickstart.rst

@@ -7,6 +7,11 @@ Quickstart
 Tmux Session Manager
 --------------------
 
+.. argparse::
+    :module: tmuxp.cli
+    :func: get_parser
+    :prog: tmuxp
+
 tmuxp launches sessions from a configuration file.
 
 Configuration files can be stored in ``$HOME/.tmuxp`` or in project

doc/requirements.pip

@@ -3,3 +3,4 @@ docutils==0.11
 sphinx==dev
 sphinxcontrib-aafig
 reportlab
+sphinx-argparse

tmuxp/cli.py

@@ -716,9 +716,11 @@ def get_parser():
                         help='Log level e.g. INFO, DEBUG, ERROR')
 
     parser.add_argument('-L', dest='socket_name', default=None,
+                        help='socket name of tmux server. Same as tmux.',
                         metavar='socket-name')
 
     parser.add_argument('-S', dest='socket_path', default=None,
+                        help='socket path of tmux server. Same as tmux.',
                         metavar='socket-path')
 
     # http://stackoverflow.com/questions/8521612/argparse-optional-subparser