Mercurial > python-cmd2
changeset 388:52ab96d4f179
fix some Sphinx warnings
| author | anatoly techtonik <techtonik@gmail.com> |
|---|---|
| date | Mon, 21 Jun 2010 17:02:20 +0300 |
| parents | 43ce9110d5a6 |
| children | be4194f41916 |
| files | docs/alternatives.rst docs/freefeatures.rst docs/index.rst docs/unfreefeatures.rst |
| diffstat | 4 files changed, 18 insertions(+), 10 deletions(-) [+] |
line wrap: on
line diff
--- a/docs/alternatives.rst Mon May 24 05:27:26 2010 -0400 +++ b/docs/alternatives.rst Mon Jun 21 17:02:20 2010 +0300 @@ -36,7 +36,7 @@ doesn't retain full cmd_ compatibility, shares its basic structure with cmd_. -.. _cmdln_ http://pypi.python.org/pypi/cmdln +.. _cmdln: http://pypi.python.org/pypi/cmdln .. _CmdLoop: http://pypi.python.org/pypi/CmdLoop
--- a/docs/freefeatures.rst Mon May 24 05:27:26 2010 -0400 +++ b/docs/freefeatures.rst Mon Jun 21 17:02:20 2010 +0300 @@ -5,6 +5,8 @@ These features are provided "for free" to a cmd_-based application simply by replacing ``import cmd`` with ``import cmd2 as cmd``. +.. _cmd: http://docs.python.org/library/cmd.html#module-cmd + Script files ============ @@ -28,7 +30,7 @@ ``app.commentGrammars`` with a different pyparsing_ grammar. -Comments can be useful in :ref:`script`s. Used +Comments can be useful in :ref:`scripts`. Used in an interactive session, they may indicate mental imbalance. @@ -42,6 +44,8 @@ (Cmd) speak it was /* not */ delicious! # Yuck! it was delicious! +.. _pyparsing: http://pyparsing.wikispaces.com/ + Commands at invocation ====================== @@ -70,16 +74,14 @@ - sent to the paste buffer, ready for the next Copy operation, by ending with a bare ``>``, as in ``mycommand args >``.. Redirecting to paste buffer requires software to be installed on the operating - system, pywin32_ on Windows or xclip_ on *nix. + system, pywin32_ on Windows or xclip_ on \*nix. -.. _pywin32:: http://sourceforge.net/projects/pywin32/ -.. _xclip:: http://www.cyberciti.biz/faq/xclip-linux-insert-files-command-output-intoclipboard/ +.. _pywin32: http://sourceforge.net/projects/pywin32/ +.. _xclip: http://www.cyberciti.biz/faq/xclip-linux-insert-files-command-output-intoclipboard/ Python ====== -:: - The ``py`` command will run its arguments as a Python command. Entered without arguments, it enters an interactive Python session. That session can call
--- a/docs/index.rst Mon May 24 05:27:26 2010 -0400 +++ b/docs/index.rst Mon Jun 21 17:02:20 2010 +0300 @@ -38,7 +38,7 @@ * `cmd2 project page`_ * `PyCon 2010 presentation <http://us.pycon.org/2010/conference/talks/#proposal_link_153>`_, *Easy Command-Line Applications with cmd and cmd2*: - `slides <http://packages.python.org/cmd2/>`_, + :doc:`slides <pycon2010/pycon2010>`, `video <http://python.mirocommunity.com/video/1533/easy-command-line-applications>`_ These docs will refer to ``App`` as your ``cmd2.Cmd``
--- a/docs/unfreefeatures.rst Mon May 24 05:27:26 2010 -0400 +++ b/docs/unfreefeatures.rst Mon Jun 21 17:02:20 2010 +0300 @@ -23,7 +23,7 @@ ``cmd2`` passes ``arg`` to a ``do_`` method (or ``default`) as a ParsedString, a subclass of string that includes an attribute ``parsed``. -``parsed`` is a ``pyparsing.ParseResults``_ +``parsed`` is a ``pyparsing.ParseResults`` object produced by applying a pyparsing_ grammar applied to ``arg``. It may include: @@ -60,7 +60,7 @@ If ``parsed`` does not contain an attribute, querying for it will return ``None``. (This -is a characteristic of ``pyparsing.ParseResults``_.) +is a characteristic of ``pyparsing.ParseResults``.) ParsedString was developed to support sqlpython_ and reflects its needs. The parsing grammar and @@ -74,6 +74,12 @@ be no result unless you change your application to *use* ``arg.parsed``.) +.. _sqlpython: http://pypi.python.org/pypi/sqlpython/ + +.. _cmd: http://docs.python.org/library/cmd.html#module-cmd + +.. _pyparsing: http://pyparsing.wikispaces.com/ + Environment parameters ======================