diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/index.rst | 2 | ||||
| -rw-r--r-- | docs/api/table_creator.rst | 35 | ||||
| -rw-r--r-- | docs/api/utils.rst | 1 |
3 files changed, 38 insertions, 0 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst index aa3371b9..7b66a684 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** @@ -50,4 +51,5 @@ This documentation is for ``cmd2`` version |version|. - :ref:`api/plugin:cmd2.plugin` - data classes for hook methods - :ref:`api/py_bridge:cmd2.py_bridge` - classes for bridging calls from the embedded python environment to the host app +- :ref:`api/table_creator:cmd2.table_creator` - table creation module - :ref:`api/constants:cmd2.constants` - just like it says on the tin 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 |