Fixed documentation build on refactoring branch

tleonhardt · tleonhardt · commit 425cd9a435c6 · 2025-08-16T23:26:40.000-04:00
diff --git a/docs/api/ansi.md b/docs/api/ansi.md
diff --git a/docs/api/clipboard.md b/docs/api/clipboard.md
@@ -0,0 +1,3 @@
+# cmd2.clipboard
+
+::: cmd2.clipboard
diff --git a/docs/api/colors.md b/docs/api/colors.md
@@ -0,0 +1,3 @@
+# cmd2.colors
+
+::: cmd2.colors
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -12,10 +12,10 @@ incremented according to the [Semantic Version Specification](https://semver.org
 ## Modules
 
 - [cmd2.Cmd](./cmd.md) - functions and attributes of the main class in this library
-- [cmd2.ansi](./ansi.md) - convenience classes and functions for generating ANSI escape sequences to
-  style text in the terminal
 - [cmd2.argparse_completer](./argparse_completer.md) - classes for `argparse`-based tab completion
 - [cmd2.argparse_custom](./argparse_custom.md) - classes and functions for extending `argparse`
+- [cmd2.clipboard](./clipboard.md) - functions to copy from and paste to the clipboard/pastebuffer
+- [cmd2.colors](./colors.md) - provides a StrEnum of Rich's named colors
 - [cmd2.command_definition](./command_definition.md) - supports the definition of commands in
   separate classes to be composed into cmd2.Cmd
 - [cmd2.constants](./constants.md) - just like it says on the tin
@@ -26,5 +26,10 @@ incremented according to the [Semantic Version Specification](https://semver.org
 - [cmd2.plugin](./plugin.md) - data classes for hook methods
 - [cmd2.py_bridge](./py_bridge.md) - classes for bridging calls from the embedded python environment
   to the host app
-- [cmd2.table_creator](./table_creator.md) - table creation module
+- [cmd2.rich_utils](./rich_utils.md) - common utilities to support Rich in cmd2 applications
+- [cmd2.rl_utils](./rl_utils.md) - imports the proper Readline for the platform and provides utility
+  functions for it
+- [cmd2.string_utils](./string_utils.md) - string utility functions
+- [cmd2.terminal_utils](./terminal_utils.md) - support for terminal control escape sequences
+- [cmd2.transcript](./transcript.md) - functions and classes for running and validating transcripts
 - [cmd2.utils](./utils.md) - various utility classes and functions
diff --git a/docs/api/rich_utils.md b/docs/api/rich_utils.md
@@ -0,0 +1,3 @@
+# cmd2.rich_utils
+
+::: cmd2.rich_utils
diff --git a/docs/api/rl_utils.md b/docs/api/rl_utils.md
@@ -0,0 +1,3 @@
+# cmd2.rl_utils
+
+::: cmd2.rl_utils
diff --git a/docs/api/string_utils.md b/docs/api/string_utils.md
@@ -0,0 +1,3 @@
+# cmd2.string_utils
+
+::: cmd2.string_utils
diff --git a/docs/api/table_creator.md b/docs/api/table_creator.md
diff --git a/docs/api/terminal_utils.md b/docs/api/terminal_utils.md
@@ -0,0 +1,3 @@
+# cmd2.terminal_utils
+
+::: cmd2.terminal_utils
diff --git a/docs/api/transcript.md b/docs/api/transcript.md
@@ -0,0 +1,3 @@
+# cmd2.transcript
+
+::: cmd2.transcript
diff --git a/docs/features/generating_output.md b/docs/features/generating_output.md
@@ -43,11 +43,11 @@ def do_echo(self, args):
 ## Error Messages
 
 When an error occurs in your program, you can display it on `sys.stderr` by calling the
-`.cmd2.Cmd.perror` method. By default this method applies `cmd2.styles.ERROR` to the output.
+`.cmd2.Cmd.perror` method. By default this method applies `Cmd2Style.ERROR` to the output.
 
 ## Warning Messages
 
-`cmd2.Cmd.pwarning` is just like `cmd2.Cmd.perror` but applies `cmd2.styles.WARNING` to the output.
+`cmd2.Cmd.pwarning` is just like `cmd2.Cmd.perror` but applies `Cmd2Style.WARNING` to the output.
 
 ## Feedback
 
@@ -84,7 +84,13 @@ You can add your own [ANSI escape sequences](https://en.wikipedia.org/wiki/ANSI_
 to your output which tell the terminal to change the foreground and background colors.
 
 `cmd2` provides a number of convenience functions and classes for adding color and other styles to
-text. These are all documented in [cmd2.ansi][].
+text. These are all based on [rich](https://github.com/Textualize/rich) and are documented in the
+following sectins:
+
+- [cmd2.colors][]
+- [cmd2.rich_utils][]
+- [cmd2.string_utils][]
+- [cmd2.terminal_utils][]
 
 After adding the desired escape sequences to your output, you should use one of these methods to
 present the output to the user:
diff --git a/docs/features/table_creation.md b/docs/features/table_creation.md
@@ -1,33 +1,9 @@
 # Table Creation
 
-`cmd2` provides a table creation class called `cmd2.table_creator.TableCreator`. This class handles
-ANSI style sequences and characters with display widths greater than 1 when performing width
-calculations. It was designed with the ability to build tables one row at a time. This helps when
-you have large data sets that you don't want to hold in memory or when you receive portions of the
-data set incrementally.
+As of version 3, `cmd2` no longer includes code for table creation.
 
-`TableCreator` has one public method: `cmd2.table_creator.TableCreator.generate_row()`.
+This is because `cmd2` now has a dependency on [rich](https://github.com/Textualize/rich) which has
+excellent support for this feature.
 
-This function and the `cmd2.table_creator.Column` class provide all features needed to build tables
-with headers, borders, colors, horizontal and vertical alignment, and wrapped text. However, it's
-generally easier to inherit from this class and implement a more granular API rather than use
-`TableCreator` directly.
-
-The following table classes build upon `TableCreator` and are provided in the
-[cmd2.table_creater](../api/table_creator.md) module. They can be used as is or as examples for how
-to build your own table classes.
-
-`cmd2.table_creator.SimpleTable` - Implementation of TableCreator which generates a borderless table
-with an optional divider row after the header. This class can be used to create the whole table at
-once or one row at a time.
-
-`cmd2.table_creator.BorderedTable` - Implementation of TableCreator which generates a table with
-borders around the table and between rows. Borders between columns can also be toggled. This class
-can be used to create the whole table at once or one row at a time.
-
-`cmd2.table_creator.AlternatingTable` - Implementation of BorderedTable which uses background colors
-to distinguish between rows instead of row border lines. This class can be used to create the whole
-table at once or one row at a time.
-
-See the [table_creation](https://github.com/python-cmd2/cmd2/blob/main/examples/table_creation.py)
-example to see these classes in use
+Please see rich's docummentation on [Tables](https://rich.readthedocs.io/en/latest/tables.html) for
+more information.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -200,9 +200,10 @@ nav:
   - API Reference:
       - api/index.md
       - api/cmd.md
-      - api/ansi.md
       - api/argparse_completer.md
       - api/argparse_custom.md
+      - api/clipboard.md
+      - api/colors.md
       - api/command_definition.md
       - api/constants.md
       - api/decorators.md
@@ -211,7 +212,11 @@ nav:
       - api/parsing.md
       - api/plugin.md
       - api/py_bridge.md
-      - api/table_creator.md
+      - api/rich_utils.md
+      - api/rl_utils.md
+      - api/string_utils.md
+      - api/terminal_utils.md
+      - api/transcript.md
       - api/utils.md
   - Meta:
       - doc_conventions.md

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.clipboard`
	`2`	`+`
	`3`	`+::: cmd2.clipboard`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.colors`
	`2`	`+`
	`3`	`+::: cmd2.colors`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.rich_utils`
	`2`	`+`
	`3`	`+::: cmd2.rich_utils`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.rl_utils`
	`2`	`+`
	`3`	`+::: cmd2.rl_utils`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.string_utils`
	`2`	`+`
	`3`	`+::: cmd2.string_utils`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.terminal_utils`
	`2`	`+`
	`3`	`+::: cmd2.terminal_utils`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# cmd2.transcript`
	`2`	`+`
	`3`	`+::: cmd2.transcript`