diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/history.rst | 3 | ||||
| -rw-r--r-- | docs/api/index.rst | 27 | ||||
| -rw-r--r-- | docs/api/parsing.rst | 15 |
3 files changed, 37 insertions, 8 deletions
diff --git a/docs/api/history.rst b/docs/api/history.rst index 3a3ae2c4..5658238d 100644 --- a/docs/api/history.rst +++ b/docs/api/history.rst @@ -1,6 +1,9 @@ cmd2.history =============== +Classes for storing the history of previously entered commands. + + .. autoclass:: cmd2.history.History :members: diff --git a/docs/api/index.rst b/docs/api/index.rst index d5fc013b..e33040d0 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -16,15 +16,38 @@ This documentation is for version |version| of ``cmd2``. .. toctree:: :maxdepth: 1 + :hidden: cmd - parsing decorators - history + parsing argparse_completer argparse_custom ansi utils + history plugin py_bridge constants + +**Modules** + +- :ref:`api/cmd:cmd2.Cmd` - functions and attributes of the main + class in this library +- :ref:`api/decorators:cmd2.decorators` - decorators for ``cmd2`` + commands +- :ref:`api/parsing:cmd2.parsing` - classes for parsing and storing + user input +- :ref:`api/argparse_completer:cmd2.argparse_completer` - classes for + ``argparse``-based tab completion +- :ref:`api/argparse_custom:cmd2.argparse_custom` - classes and functions + for extending ``argparse`` +- :ref:`api/ansi:cmd2.ansi` - convenience classes and functions for generating + ANSI escape sequences to style text in the terminal +- :ref:`api/utils:cmd2.utils` - various utility classes and functions +- :ref:`api/history:cmd2.history` - classes for storing the history + of previously entered commands +- :ref:`api/plugin:cmd2.plugin` - data classes for hook methods +- :ref:`api/py_bridge:cmd2.py_bridge` - classes for bridging calls from the + embedded python environment to the host app +- :ref:`api/constants:cmd2.constants` - just like it says on the tin diff --git a/docs/api/parsing.rst b/docs/api/parsing.rst index c79c8f6b..fa726700 100644 --- a/docs/api/parsing.rst +++ b/docs/api/parsing.rst @@ -1,6 +1,15 @@ cmd2.parsing =============== +Classes for parsing and storing user input. + + +.. autoclass:: cmd2.parsing.StatementParser + :members: + + .. automethod:: __init__ + + .. autoclass:: cmd2.Statement :members: @@ -67,9 +76,3 @@ cmd2.parsing If output was redirected by the user, this contains the requested destination with quotes preserved. - - -.. autoclass:: cmd2.parsing.StatementParser - :members: - - .. automethod:: __init__ |