diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-24 21:53:34 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-24 21:53:34 -0700 |
| commit | 654e8981ac1b58c4029e556c65f2ca889275ba44 (patch) | |
| tree | e859af01a274b04c62f5257c3aba639c66325944 /docs/api/index.rst | |
| parent | be84cb1c469ebbfc365a15e3096d786756ce5b76 (diff) | |
| download | cmd2-git-654e8981ac1b58c4029e556c65f2ca889275ba44.tar.gz | |
Revise table of contents to include a description of each module
Diffstat (limited to 'docs/api/index.rst')
| -rw-r--r-- | docs/api/index.rst | 27 |
1 files changed, 25 insertions, 2 deletions
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 |