diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-07-06 16:57:18 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-07-06 16:57:18 -0400 |
| commit | 5d191c2ad3d9b95648f65525202b8d8bd0d73450 (patch) | |
| tree | d87ccb7ac511dcb9c95505e23b49a575e5281072 /docs | |
| parent | bbae658da66438340bd6b8b7aa15998561c1a853 (diff) | |
| download | cmd2-git-5d191c2ad3d9b95648f65525202b8d8bd0d73450.tar.gz | |
Added autoclass documentation for cmd2.Cmd in cmd.rst
This required whitespace tweaks to a number of docstrings.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/cmd.rst | 3 | ||||
| -rw-r--r-- | docs/freefeatures.rst | 5 | ||||
| -rw-r--r-- | docs/integrating.rst | 1 | ||||
| -rw-r--r-- | docs/unfreefeatures.rst | 5 |
4 files changed, 14 insertions, 0 deletions
diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index 35e9ae69..4f88101e 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -1,2 +1,5 @@ cmd2.Cmd ======== + +.. autoclass:: cmd2.cmd2.Cmd + :members: diff --git a/docs/freefeatures.rst b/docs/freefeatures.rst index 7c652159..25fe3be9 100644 --- a/docs/freefeatures.rst +++ b/docs/freefeatures.rst @@ -21,10 +21,13 @@ Simply include one command per line, typed exactly as you would inside a ``cmd2`` application. .. automethod:: cmd2.cmd2.Cmd.do_run_script + :noindex: .. automethod:: cmd2.cmd2.Cmd.do__relative_run_script + :noindex: .. automethod:: cmd2.cmd2.Cmd.do_edit + :noindex: Startup Initialization Script @@ -257,8 +260,10 @@ Several generically useful commands are defined with automatically included ``do_`` methods. .. automethod:: cmd2.cmd2.Cmd.do_quit + :noindex: .. automethod:: cmd2.cmd2.Cmd.do_shell + :noindex: ( ``!`` is a shortcut for ``shell``; thus ``!ls`` is equivalent to ``shell ls``.) diff --git a/docs/integrating.rst b/docs/integrating.rst index 064e4e67..9b0cf737 100644 --- a/docs/integrating.rst +++ b/docs/integrating.rst @@ -161,3 +161,4 @@ with several disadvantages, including: Here is a little more info on ``runcmds_plus_hooks``: .. automethod:: cmd2.cmd2.Cmd.runcmds_plus_hooks + :noindex: diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index 8d2905ad..19c4e547 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -110,9 +110,13 @@ output flexibility). ``cmd2`` applications can use ``self.poutput('output')``, - Option to display long output using a pager via ``ppaged()`` .. automethod:: cmd2.cmd2.Cmd.poutput + :noindex: .. automethod:: cmd2.cmd2.Cmd.perror + :noindex: .. automethod:: cmd2.cmd2.Cmd.pfeedback + :noindex: .. automethod:: cmd2.cmd2.Cmd.ppaged + :noindex: Colored Output @@ -166,6 +170,7 @@ Presents numbered options to user, as bash ``select``. ``app.select``, not ``app.do_select``). .. automethod:: cmd2.cmd2.Cmd.select + :noindex: :: |