Skip to content

Commit 44bf30a

Browse files
committed
Instead of using automodule, only document public api functions
1 parent 94e6309 commit 44bf30a

File tree

1 file changed

+74
-1
lines changed

1 file changed

+74
-1
lines changed

docs/api/utils.rst

Lines changed: 74 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,78 @@
11
cmd2.utils
22
==========
33

4-
.. automodule:: cmd2.utils
4+
5+
Settings
6+
--------
7+
8+
.. autoclass:: cmd2.utils.Settable
9+
:members:
10+
11+
.. automethod:: __init__
12+
13+
14+
Quote Handling
15+
--------------
16+
17+
.. autofunction:: cmd2.utils.is_quoted
18+
19+
.. autofunction:: cmd2.utils.quote_string
20+
21+
.. autofunction:: cmd2.utils.quote_string_if_needed
22+
23+
.. autofunction:: cmd2.utils.strip_quotes
24+
25+
26+
IO Handling
27+
-----------
28+
29+
.. autoclass:: cmd2.utils.StdSim
30+
:members:
31+
32+
.. autoclass:: cmd2.utils.ByteBuf
533
:members:
34+
35+
.. autoclass:: cmd2.utils.ProcReader
36+
:members:
37+
38+
39+
Tab Completion
40+
--------------
41+
42+
.. autoclass:: cmd2.utils.CompletionError
43+
:members:
44+
45+
.. autofunction:: cmd2.utils.remove_duplicates
46+
47+
.. autofunction:: cmd2.utils.alphabetical_sort
48+
49+
.. autofunction:: cmd2.utils.natural_sort
50+
51+
.. autofunction:: cmd2.utils.basic_complete
52+
53+
54+
Text Alignment
55+
--------------
56+
57+
.. autoclass:: cmd2.utils.TextAlignment
58+
:members:
59+
60+
.. autofunction:: cmd2.utils.align_text
61+
62+
.. autofunction:: cmd2.utils.align_left
63+
64+
.. autofunction:: cmd2.utils.align_right
65+
66+
.. autofunction:: cmd2.utils.align_center
67+
68+
.. autofunction:: cmd2.utils.truncate_line
69+
70+
71+
Miscellaneous
72+
-------------
73+
74+
.. autofunction:: cmd2.utils.str_to_bool
75+
76+
.. autofunction:: cmd2.utils.namedtuple_with_defaults
77+
78+
.. autofunction:: cmd2.utils.categorize

0 commit comments

Comments
 (0)