summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoranatoly techtonik <techtonik@gmail.com>2010-06-21 17:02:20 +0300
committeranatoly techtonik <techtonik@gmail.com>2010-06-21 17:02:20 +0300
commitecbc63fda1dd06416c5293e0183806fda5e93008 (patch)
treef0e192e44f1f8cd80c8a2d0cb5aa20055e1259cc
parentaeb1d0828d158c87512507c73dcce3e5c8526597 (diff)
downloadcmd2-git-ecbc63fda1dd06416c5293e0183806fda5e93008.tar.gz
fix some Sphinx warnings
-rw-r--r--docs/alternatives.rst2
-rw-r--r--docs/freefeatures.rst14
-rw-r--r--docs/index.rst2
-rw-r--r--docs/unfreefeatures.rst10
4 files changed, 18 insertions, 10 deletions
diff --git a/docs/alternatives.rst b/docs/alternatives.rst
index 34f1a0c8..bbf2ae2e 100644
--- a/docs/alternatives.rst
+++ b/docs/alternatives.rst
@@ -36,7 +36,7 @@ cmdln_, another package in PyPI, is an extension to cmd_ and, though it
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
diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst
index 3fc137b2..fe1715f1 100644
--- a/docs/freefeatures.rst
+++ b/docs/freefeatures.rst
@@ -5,6 +5,8 @@ Features requiring no modifications
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 @@ are recognized; you may change this by overriding
``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 @@ mental imbalance.
(Cmd) speak it was /* not */ delicious! # Yuck!
it was delicious!
+.. _pyparsing: http://pyparsing.wikispaces.com/
+
Commands at invocation
======================
@@ -70,16 +74,14 @@ As in a Unix shell, output of a command can be redirected:
- 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
diff --git a/docs/index.rst b/docs/index.rst
index e463f2d8..b77e8bc9 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -38,7 +38,7 @@ Resources
* `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``
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst
index 84ecf1c3..61df0014 100644
--- a/docs/unfreefeatures.rst
+++ b/docs/unfreefeatures.rst
@@ -23,7 +23,7 @@ Parsed statements
``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 @@ suffix
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 @@ changes from the cmd_ standard, but there will
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
======================