diff options
| author | kotfu <kotfu@kotfu.net> | 2020-02-10 16:06:24 -0700 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2020-02-10 16:06:24 -0700 |
| commit | f4c745573e4d777d53e1bcfac743c3b437904034 (patch) | |
| tree | a1fbba0641d783a982df5c30a0f6ee8b79138e8d /docs/api | |
| parent | 2c4207f4ee12bf22c1ba7d7300554dedf6d53909 (diff) | |
| download | cmd2-git-f4c745573e4d777d53e1bcfac743c3b437904034.tar.gz | |
Begin process of combining utils api docs into a single document
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/index.rst | 1 | ||||
| -rw-r--r-- | docs/api/utility_classes.rst | 14 | ||||
| -rw-r--r-- | docs/api/utility_functions.rst | 52 | ||||
| -rw-r--r-- | docs/api/utils.rst | 5 |
4 files changed, 6 insertions, 66 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst index f0324eab..4781a249 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -8,5 +8,6 @@ API Reference decorators exceptions ansi + utils utility_classes utility_functions diff --git a/docs/api/utility_classes.rst b/docs/api/utility_classes.rst index 2ee92ced..99a714ee 100644 --- a/docs/api/utility_classes.rst +++ b/docs/api/utility_classes.rst @@ -1,16 +1,2 @@ Utility Classes =============== - -.. autoclass:: cmd2.utils.Settable - - .. automethod:: __init__ - -.. 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 index 4f788e3d..0fe6b341 100644 --- a/docs/api/utility_functions.rst +++ b/docs/api/utility_functions.rst @@ -1,54 +1,2 @@ Utility Functions ================= - -.. autofunction:: cmd2.utils.is_quoted - -.. autofunction:: cmd2.utils.quote_string_if_needed - -.. autofunction:: cmd2.utils.strip_quotes - -.. autofunction:: cmd2.decorators.categorize - -.. autofunction:: cmd2.utils.align_text - -.. autofunction:: cmd2.utils.align_left - -.. autofunction:: cmd2.utils.align_center - -.. autofunction:: cmd2.utils.align_right - -.. autofunction:: cmd2.utils.truncate_line - -.. autofunction:: cmd2.utils.strip_quotes - -.. autofunction:: cmd2.utils.namedtuple_with_defaults - -.. 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 diff --git a/docs/api/utils.rst b/docs/api/utils.rst new file mode 100644 index 00000000..8019b379 --- /dev/null +++ b/docs/api/utils.rst @@ -0,0 +1,5 @@ +cmd2.utils +========== + +.. automodule:: cmd2.utils + :members: |