From e1256ccb5a78d8cb3b4f2ab9904d80693b6959c9 Mon Sep 17 00:00:00 2001 From: Kevin Van Brunt Date: Wed, 22 Apr 2020 00:32:55 -0400 Subject: Updated docs --- docs/api/index.rst | 1 + docs/api/table_creator.rst | 35 +++++++++++++++++++++++++++++++++++ docs/api/utils.rst | 1 + 3 files changed, 37 insertions(+) create mode 100644 docs/api/table_creator.rst (limited to 'docs/api') 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 -- cgit v1.2.1