diff options
author | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-22 00:32:55 -0400 |
---|---|---|
committer | Kevin Van Brunt <kmvanbrunt@gmail.com> | 2020-04-22 00:32:55 -0400 |
commit | e1256ccb5a78d8cb3b4f2ab9904d80693b6959c9 (patch) | |
tree | 8af8f150e8c84bfd671e22b6bd988e96d6fc1f1c /docs | |
parent | a6f04d8f8d999a1440a34307d3646a33b2b23d74 (diff) | |
download | cmd2-git-e1256ccb5a78d8cb3b4f2ab9904d80693b6959c9.tar.gz |
Updated docs
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api/index.rst | 1 | ||||
-rw-r--r-- | docs/api/table_creator.rst | 35 | ||||
-rw-r--r-- | docs/api/utils.rst | 1 |
3 files changed, 37 insertions, 0 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst index aa3371b9..2bb1be2c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -28,6 +28,7 @@ This documentation is for ``cmd2`` version |version|. history plugin py_bridge + table_creator constants **Modules** diff --git a/docs/api/table_creator.rst b/docs/api/table_creator.rst new file mode 100644 index 00000000..00dd70ba --- /dev/null +++ b/docs/api/table_creator.rst @@ -0,0 +1,35 @@ +cmd2.table_creator +================== + +.. autoclass:: cmd2.table_creator.HorizontalAlignment + :members: + :undoc-members: + +.. autoclass:: cmd2.table_creator.VerticalAlignment + :members: + :undoc-members: + +.. autoclass:: cmd2.table_creator.Column + :members: + + .. automethod:: __init__ + +.. autoclass:: cmd2.table_creator.TableCreator + :members: + + .. automethod:: __init__ + +.. autoclass:: cmd2.table_creator.SimpleTable + :members: + + .. automethod:: __init__ + +.. autoclass:: cmd2.table_creator.BorderedTable + :members: + + .. automethod:: __init__ + +.. autoclass:: cmd2.table_creator.AlternatingTable + :members: + + .. automethod:: __init__ diff --git a/docs/api/utils.rst b/docs/api/utils.rst index 8121fea8..d9166401 100644 --- a/docs/api/utils.rst +++ b/docs/api/utils.rst @@ -50,6 +50,7 @@ Text Alignment .. autoclass:: cmd2.utils.TextAlignment :members: + :undoc-members: .. autofunction:: cmd2.utils.align_text |