diff options
| author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-01-16 13:26:49 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-01-16 13:26:49 -0500 |
| commit | e3b68241eb532dee6430c339534e2ee890abe5a3 (patch) | |
| tree | 88777e27696ec208c193c13838a6c0d3dcc95f5f /docs/api | |
| parent | d4556962799e68ea4d54ff86186428d17edcaef9 (diff) | |
| parent | 64c05ab4fd71f2c235644af2d18672edf6757702 (diff) | |
| download | cmd2-git-e3b68241eb532dee6430c339534e2ee890abe5a3.tar.gz | |
Merge pull request #847 from python-cmd2/generating_output_docs
Generating output docs
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/ansi.rst | 5 | ||||
| -rw-r--r-- | docs/api/cmd.rst | 17 | ||||
| -rw-r--r-- | docs/api/index.rst | 1 |
3 files changed, 23 insertions, 0 deletions
diff --git a/docs/api/ansi.rst b/docs/api/ansi.rst new file mode 100644 index 00000000..e361bd4f --- /dev/null +++ b/docs/api/ansi.rst @@ -0,0 +1,5 @@ +cmd2.ansi +========= + +.. automodule:: cmd2.ansi + :members: diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst index 4f88101e..ee8d7c67 100644 --- a/docs/api/cmd.rst +++ b/docs/api/cmd.rst @@ -3,3 +3,20 @@ cmd2.Cmd .. autoclass:: cmd2.cmd2.Cmd :members: + + .. attribute:: help_error + + The error message displayed to the user when they request help for a + command with no help defined. + + .. attribute:: default_error + + The error message displayed when a non-existent command is run. + + .. attribute:: settable + + This dictionary contains the name and description of all settings available to users. + + Users use the :ref:`features/builtin_commands:set` command to view and + modify settings. Settings are stored in instance attributes with the + same name as the setting. diff --git a/docs/api/index.rst b/docs/api/index.rst index 94d0fdd4..f0324eab 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -7,5 +7,6 @@ API Reference cmd decorators exceptions + ansi utility_classes utility_functions |