Merge branch 'master' into auto_completer_refactor

6 files changed, 92 insertions, 0 deletions

diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst
new file mode 100644
index 00000000..4f88101e
--- /dev/null
+++ b/docs/api/cmd.rst
@@ -0,0 +1,5 @@
+cmd2.Cmd
+========
+
+.. autoclass:: cmd2.cmd2.Cmd
+    :members:
diff --git a/docs/api/decorators.rst b/docs/api/decorators.rst
new file mode 100644
index 00000000..d7bfa138
--- /dev/null
+++ b/docs/api/decorators.rst
@@ -0,0 +1,10 @@
+Decorators
+==========
+
+.. autofunction:: cmd2.cmd2.with_category
+
+.. autofunction:: cmd2.cmd2.with_argument_list
+
+.. autofunction:: cmd2.cmd2.with_argparser_and_unknown_args
+
+.. autofunction:: cmd2.cmd2.with_argparser
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
new file mode 100644
index 00000000..656c4a5a
--- /dev/null
+++ b/docs/api/exceptions.rst
@@ -0,0 +1,6 @@
+Exceptions
+==========
+
+.. autoexception:: cmd2.cmd2.EmbeddedConsoleExit
+
+.. autoexception:: cmd2.cmd2.EmptyStatement
diff --git a/docs/api/index.rst b/docs/api/index.rst
new file mode 100644
index 00000000..94d0fdd4
--- /dev/null
+++ b/docs/api/index.rst
@@ -0,0 +1,11 @@
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   cmd
+   decorators
+   exceptions
+   utility_classes
+   utility_functions
diff --git a/docs/api/utility_classes.rst b/docs/api/utility_classes.rst
new file mode 100644
index 00000000..7ed0c584
--- /dev/null
+++ b/docs/api/utility_classes.rst
@@ -0,0 +1,12 @@
+Utility Classes
+===============
+
+.. autoclass:: cmd2.utils.StdSim
+
+.. autoclass:: cmd2.utils.ByteBuf
+
+.. autoclass:: cmd2.utils.ProcReader
+
+.. autoclass:: cmd2.utils.ContextFlag
+
+.. autoclass:: cmd2.utils.RedirectionSavedState
diff --git a/docs/api/utility_functions.rst b/docs/api/utility_functions.rst
new file mode 100644
index 00000000..57a720bf
--- /dev/null
+++ b/docs/api/utility_functions.rst
@@ -0,0 +1,48 @@
+Utility Functions
+=================
+
+.. autofunction:: cmd2.utils.is_quoted
+
+.. autofunction:: cmd2.utils.quote_string_if_needed
+
+.. autofunction:: cmd2.utils.strip_quotes
+
+.. autofunction:: cmd2.cmd2.categorize
+
+.. autofunction:: cmd2.utils.center_text
+
+.. autofunction:: cmd2.utils.strip_quotes
+
+.. autofunction:: cmd2.utils.namedtuple_with_defaults
+
+.. autofunction:: cmd2.utils.cast
+
+.. autofunction:: cmd2.utils.which
+
+.. autofunction:: cmd2.utils.is_text_file
+
+.. autofunction:: cmd2.utils.remove_duplicates
+
+.. autofunction:: cmd2.utils.norm_fold
+
+.. autofunction:: cmd2.utils.try_int_or_force_to_lower_case
+
+.. autofunction:: cmd2.utils.alphabetical_sort
+
+.. autofunction:: cmd2.utils.unquote_specific_tokens
+
+.. autofunction:: cmd2.utils.natural_sort
+
+.. autofunction:: cmd2.utils.natural_keys
+
+.. autofunction:: cmd2.utils.expand_user_in_tokens
+
+.. autofunction:: cmd2.utils.expand_user
+
+.. autofunction:: cmd2.utils.find_editor
+
+.. autofunction:: cmd2.utils.get_exes_in_path
+
+.. autofunction:: cmd2.utils.files_from_glob_patterns
+
+.. autofunction:: cmd2.utils.files_from_glob_pattern