From 92ae130c38520b249eb7351cfb0da1ad67d3d3cf Mon Sep 17 00:00:00 2001 From: kotfu Date: Tue, 2 Jul 2019 19:02:36 -0600 Subject: Major overhaul of documentation structure for #709 --- docs/api/cmd.rst | 2 ++ docs/api/decorators.rst | 10 +++++++++ docs/api/exceptions.rst | 6 ++++++ docs/api/utility_classes.rst | 12 +++++++++++ docs/api/utility_functions.rst | 48 ++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 78 insertions(+) create mode 100644 docs/api/cmd.rst create mode 100644 docs/api/decorators.rst create mode 100644 docs/api/exceptions.rst create mode 100644 docs/api/utility_classes.rst create mode 100644 docs/api/utility_functions.rst (limited to 'docs/api') diff --git a/docs/api/cmd.rst b/docs/api/cmd.rst new file mode 100644 index 00000000..f9eefab2 --- /dev/null +++ b/docs/api/cmd.rst @@ -0,0 +1,2 @@ +cmd object +========== 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/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 -- cgit v1.2.1