Fixed rest of Markdown and got basic API documentation workign well

Author: tleonhardt

docs/api/ansi.md

@@ -1,7 +1,3 @@
 # cmd2.ansi
 
-TODO replace with mkdocstrings:
-
-    > ::: {.automodule members=""}
-    > cmd2.ansi
-    > :::
+::: cmd2.ansi

docs/api/argparse_completer.md

@@ -1,7 +1,3 @@
-# cmd2.argparse[completer]{#completer}
+# cmd2.argparse_completer
 
-TODO replace with mkdocstrings:
-
-    > ::: {.automodule members=""}
-    > cmd2.argparse[completer]{#completer}
-    > :::
+::: cmd2.argparse_completer

docs/api/argparse_custom.md

@@ -1,63 +1,3 @@
-# cmd2.argparse[custom]{#custom}
+# cmd2.argparse_custom
 
-TODO replace with mkdocstrings:
-
-    > ::: {.automodule members=""}
-    > cmd2.argparse[custom]{#custom}
-    > :::
-
-## Added Accessor Methods
-
-TODO replace with mkdocstrings:
-
-    > ::: autofunction
-    > [action_get_choices_callable]{#action_get_choices_callable}
-    > :::
-    >
-    > ::: autofunction
-    > [action_set_choices_provider]{#action_set_choices_provider}
-    > :::
-    >
-    > ::: autofunction
-    > [action_set_completer]{#action_set_completer}
-    > :::
-    >
-    > ::: autofunction
-    > [action_get_descriptive_header]{#action_get_descriptive_header}
-    > :::
-    >
-    > ::: autofunction
-    > [action_set_descriptive_header]{#action_set_descriptive_header}
-    > :::
-    >
-    > ::: autofunction
-    > [action_get_nargs_range]{#action_get_nargs_range}
-    > :::
-    >
-    > ::: autofunction
-    > [action_set_nargs_range]{#action_set_nargs_range}
-    > :::
-    >
-    > ::: autofunction
-    > [action_get_suppress_tab_hint]{#action_get_suppress_tab_hint}
-    > :::
-    >
-    > ::: autofunction
-    > [action_set_suppress_tab_hint]{#action_set_suppress_tab_hint}
-    > :::
-    >
-    > ::: autofunction
-    > [ArgumentParser_get_ap_completer_type]{#argumentparser_get_ap_completer_type}
-    > :::
-    >
-    > ::: autofunction
-    > [ArgumentParser_set_ap_completer_type]{#argumentparser_set_ap_completer_type}
-    > :::
-
-## Subcommand Removal
-
-TODO replace with mkdocstrings:
-
-    > ::: autofunction
-    > [SubParsersAction_remove_parser]{#subparsersaction_remove_parser}
-    > :::
+::: cmd2.argparse_custom

docs/api/cmd.md

@@ -1,86 +1,3 @@
 # cmd2.Cmd
 
-TODO replace with mkdocstrings:
-
-    > :::::::::::::::: {.autoclass members=""}
-    > cmd2.Cmd
-    >
-    > ::: automethod
-    > :::
-    >
-    > ::: attribute
-    > default[error]{#error}
-    >
-    > The error message displayed when a non-existent command is run. Default: `{} is not a recognized command, alias, or macro.`
-    > :::
-    >
-    > ::: attribute
-    > help[error]{#error}
-    >
-    > The error message displayed to the user when they request help for a command with no help defined. Default: `No help on {}`
-    > :::
-    >
-    > ::: attribute
-    > prompt
-    >
-    > The prompt issued to solicit input. The default value is `(Cmd)`. See `features/prompt:Prompt`{.interpreted-text role="ref"} for more information.
-    > :::
-    >
-    > ::: attribute
-    > continuation[prompt]{#prompt}
-    >
-    > The prompt issued to solicit input for the 2nd and subsequent lines of a `multiline command <features/multiline_commands:Multiline Commands>`{.interpreted-text role="ref"} Default: `>`.
-    > :::
-    >
-    > ::: attribute
-    > echo
-    >
-    > If `True`, output the prompt and user input before executing the command. When redirecting a series of commands to an output file, this allows you to see the command in the output.
-    > :::
-    >
-    > ::: attribute
-    > settable
-    >
-    > This dictionary contains the name and description of all settings available to users.
-    >
-    > Users use the `features/builtin_commands:set`{.interpreted-text role="ref"} command to view and modify settings. Settings are stored in instance attributes with the same name as the setting.
-    > :::
-    >
-    > ::: attribute
-    > history
-    >
-    > A record of previously entered commands.
-    >
-    > This attribute is an instance of `cmd2.history.History`{.interpreted-text role="class"}, and each command is an instance of `cmd2.Statement`{.interpreted-text role="class"}.
-    > :::
-    >
-    > ::: attribute
-    > statement[parser]{#parser}
-    >
-    > An instance of `cmd2.parsing.StatementParser`{.interpreted-text role="class"} initialized and configured appropriately for parsing user input.
-    > :::
-    >
-    > ::: attribute
-    > intro
-    >
-    > Set an introduction message which is displayed to the user before the `features/hooks:Command Processing Loop`{.interpreted-text role="ref"} begins.
-    > :::
-    >
-    > ::: attribute
-    > py[bridge_name]{#bridge_name}
-    >
-    > The symbol name which `features/scripting:Python Scripts`{.interpreted-text role="ref"} run using the `features/builtin_commands:run_pyscript`{.interpreted-text role="ref"} command can use to reference the parent `cmd2` application.
-    > :::
-    >
-    > ::: attribute
-    > allow[clipboard]{#clipboard}
-    >
-    > If `True`, `cmd2` will allow output to be written to or appended to the operating system pasteboard. If `False`, this capability will not be allowed. See `features/clipboard:Clipboard Integration`{.interpreted-text role="ref"} for more information.
-    > :::
-    >
-    > ::: attribute
-    > suggest[similar_command]{#similar_command}
-    >
-    > If `True`, `cmd2` will attempt to suggest the most similar command when the user types a command that does not exist. Default: `False`.
-    > :::
-    > ::::::::::::::::
+::: cmd2.Cmd

docs/api/command_definition.md

@@ -1,7 +1,3 @@
-# cmd2.command[definition]{#definition}
+# cmd2.command_definition
 
-TODO replace with mkdocstrings:
-
-    > ::: {.automodule members=""}
-    > cmd2.command[definition]{#definition}
-    > :::
+::: cmd2.command_definition

docs/api/constants.md

@@ -1,26 +1,3 @@
 # cmd2.constants
 
-TODO replace with mkdocstrings:
-
-    > ::::: automodule
-    > cmd2.constants
-    >
-    > ::: data
-    > DEFAULT[SHORTCUTS]{#shortcuts}
-    >
-    > If you do not supply shortcuts to `cmd2.Cmd.__init__`{.interpreted-text role="meth"}, the shortcuts defined here will be used instead.
-    > :::
-    >
-    > ::: data
-    > COMMAND[NAME]{#name}
-    >
-    > Used by `cmd2.Cmd.disable_command`{.interpreted-text role="meth"} and `cmd2.Cmd.disable_category`{.interpreted-text role="meth"}. Those methods allow you to selectively disable single commands or an entire category of commands. Should you want to include the name of the command in the error message displayed to the user when they try and run a disabled command, you can include this constant in the message where you would like the name of the command to appear. `cmd2` will replace this constant with the name of the command the user tried to run before displaying the error message.
-    >
-    > This constant is imported into the package namespace; the preferred syntax to import and reference it is:
-    >
-    >     import cmd2
-    >     errmsg = "The {} command is currently disabled.".format(cmd2.COMMAND_NAME)
-    >
-    > See `src/examples/help_categories.py` for an example.
-    > :::
-    > :::::
+::: cmd2.constants

docs/api/exceptions.md

@@ -1,25 +1,3 @@
 # cmd2.exceptions
 
-Custom cmd2 exceptions
-
-TODO replace with mkdocstrings:
-
-    > ::: {.autoclass members=""}
-    > cmd2.exceptions.SkipPostcommandHooks
-    > :::
-    >
-    > ::: {.autoclass members=""}
-    > cmd2.exceptions.Cmd2ArgparseError
-    > :::
-    >
-    > ::: {.autoclass members=""}
-    > cmd2.exceptions.CommandSetRegistrationError
-    > :::
-    >
-    > ::: {.autoclass members=""}
-    > cmd2.exceptions.CompletionError
-    > :::
-    >
-    > ::: {.autoclass members=""}
-    > cmd2.exceptions.PassThroughException
-    > :::
+::: cmd2.exceptions

docs/api/history.md

@@ -1,25 +1,3 @@
 # cmd2.history
 
-Classes for storing the history of previously entered commands.
-
-TODO replace with mkdocstrings:
-
-    > ::: {.autoclass members=""}
-    > cmd2.history.History
-    > :::
-    >
-    > ::::: {.autoclass members=""}
-    > cmd2.history.HistoryItem
-    >
-    > ::: attribute
-    > statement
-    >
-    > The `~cmd2.Statement`{.interpreted-text role="class"} object parsed from user input
-    > :::
-    >
-    > ::: attribute
-    > idx
-    >
-    > The 1-based index of this statement in the history list
-    > :::
-    > :::::
+::: cmd2.history

docs/api/index.md

@@ -10,20 +10,20 @@ If a release of this library changes any of the items documented here, the versi
 
 This documentation is for `cmd2` version {{ version }}.
 
-**Modules**
+## Modules
 
--   `api/cmd:cmd2.Cmd`{.interpreted-text role="ref"} - functions and attributes of the main class in this library
--   `api/ansi:cmd2.ansi`{.interpreted-text role="ref"} - convenience classes and functions for generating ANSI escape sequences to style text in the terminal
--   `api/argparse_completer:cmd2.argparse_completer`{.interpreted-text role="ref"} - classes for `argparse`-based tab completion
--   `api/argparse_custom:cmd2.argparse_custom`{.interpreted-text role="ref"} - classes and functions for extending `argparse`
--   `api/command_definition:cmd2.command_definition`{.interpreted-text role="ref"} - supports the definition of commands in separate classes to be composed into cmd2.Cmd
--   `api/constants:cmd2.constants`{.interpreted-text role="ref"} - just like it says on the tin
--   `api/decorators:cmd2.decorators`{.interpreted-text role="ref"} - decorators for `cmd2` commands
--   `api/exceptions:cmd2.exceptions`{.interpreted-text role="ref"} - custom `cmd2` exceptions
--   `api/history:cmd2.history`{.interpreted-text role="ref"} - classes for storing the history of previously entered commands
--   `api/parsing:cmd2.parsing`{.interpreted-text role="ref"} - classes for parsing and storing user input
--   `api/plugin:cmd2.plugin`{.interpreted-text role="ref"} - data classes for hook methods
--   `api/py_bridge:cmd2.py_bridge`{.interpreted-text role="ref"} - classes for bridging calls from the embedded python environment to the host app
--   `api/table_creator:cmd2.table_creator`{.interpreted-text role="ref"} - table creation module
--   `api/utils:cmd2.utils`{.interpreted-text role="ref"} - various utility classes and functions
--   `api/plugin_external_test:cmd2_ext_test`{.interpreted-text role="ref"} - External test plugin
+-   [cmd2.Cmd](./cmd.md) - functions and attributes of the main class in this library
+-   [cmd2.ansi](./ansi.md) - convenience classes and functions for generating ANSI escape sequences to style text in the terminal
+-   [cmd2.argparse_completer](./argparse_completer.md) - classes for `argparse`-based tab completion
+-   [cmd2.argparse_custom](./argparse_custom.md) - classes and functions for extending `argparse`
+-   [cmd2.command_definition](./command_definition.md) - supports the definition of commands in separate classes to be composed into cmd2.Cmd
+-   [cmd2.constants](./constants.md) - just like it says on the tin
+-   [cmd2.decorators](./decorators.md) - decorators for `cmd2` commands
+-   [cmd2.exceptions](./exceptions.md) - custom `cmd2` exceptions
+-   [cmd2.history](./history.md) - classes for storing the history of previously entered commands
+-   [cmd2.parsing](./parsing.md) - classes for parsing and storing user input
+-   [cmd2.plugin](./plugin.md) - data classes for hook methods
+-   [cmd2.py_bridge](./py_bridge.md) - classes for bridging calls from the embedded python environment to the host app
+-   [cmd2.table_creator](./table_creator.md) - table creation module
+-   [cmd2.utils](./utils.md) - various utility classes and functions
+-   [cmd2_ext_test](./plugin_external_test.md) - External test plugin

docs/api/parsing.md

@@ -1,83 +1,3 @@
 # cmd2.parsing
 
-Classes for parsing and storing user input.
-
-TODO replace with mkdocstrings:
-
-    > :::: {.autoclass members=""}
-    > cmd2.parsing.StatementParser
-    >
-    > ::: automethod
-    > :::
-    > ::::
-    >
-    > ::::::::::::: {.autoclass members=""}
-    > cmd2.Statement
-    >
-    > ::: attribute
-    > command
-    >
-    > The name of the command after shortcuts and macros have been expanded
-    > :::
-    >
-    > ::: attribute
-    > args
-    >
-    > The arguments to the command as a string with spaces between the words, excluding output redirection and command terminators. If the user used quotes in their input, they remain here, and you will have to handle them on your own.
-    > :::
-    >
-    > ::: attribute
-    > arg[list]{#list}
-    >
-    > The arguments to the command as a list, excluding output redirection and command terminators. Each argument is represented as an element in the list. Quoted arguments remain quoted. If you want to remove the quotes, use `cmd2.utils.strip_quotes`{.interpreted-text role="func"} or use `argv[1:]`
-    > :::
-    >
-    > ::: attribute
-    > raw
-    >
-    > If you want full access to exactly what the user typed at the input prompt you can get it, but you'll have to parse it on your own, including:
-    >
-    > > -   shortcuts and aliases
-    > > -   quoted commands and arguments
-    > > -   output redirection
-    > > -   multi-line command terminator handling
-    >
-    > If you use multiline commands, all the input will be passed to you in this string, but there will be embedded newlines where the user hit return to continue the command on the next line.
-    > :::
-    >
-    > ::: attribute
-    > multiline[command]{#command}
-    >
-    > If the command is a multi-line command, the name of the command will be in this attribute. Otherwise, it will be an empty string.
-    > :::
-    >
-    > ::: attribute
-    > terminator
-    >
-    > If the command is a multi-line command, this attribute contains the termination character entered by the user to signal the end of input
-    > :::
-    >
-    > ::: attribute
-    > suffix
-    >
-    > Any characters present between the input terminator and the output redirection tokens.
-    > :::
-    >
-    > ::: attribute
-    > pipe[to]{#to}
-    >
-    > If the user piped the output to a shell command, this attribute contains the entire shell command as a string. Otherwise it is an empty string.
-    > :::
-    >
-    > ::: attribute
-    > output
-    >
-    > If output was redirected by the user, this contains the redirection token, i.e. `>>`.
-    > :::
-    >
-    > ::: attribute
-    > output[to]{#to}
-    >
-    > If output was redirected by the user, this contains the requested destination with quotes preserved.
-    > :::
-    > :::::::::::::
+::: cmd2.parsing