diff options
| author | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-06-28 00:50:40 -0400 |
|---|---|---|
| committer | Todd Leonhardt <todd.leonhardt@gmail.com> | 2019-06-28 00:50:40 -0400 |
| commit | 62327923a0f8db318dd6ff951b9d98a6b04bdbae (patch) | |
| tree | 649ed339c867721c06ff57c67bb053a68f0a1a1a /docs | |
| parent | 307c53e9eb49aad69ba243e61d70474c384d185e (diff) | |
| download | cmd2-git-62327923a0f8db318dd6ff951b9d98a6b04bdbae.tar.gz | |
Updated Sphinx documentation and README.md
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/unfreefeatures.rst | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/unfreefeatures.rst b/docs/unfreefeatures.rst index ada3a2f6..713e44e6 100644 --- a/docs/unfreefeatures.rst +++ b/docs/unfreefeatures.rst @@ -141,7 +141,7 @@ instead. These methods have these advantages: Colored Output ============== -The output methods in the previous section all honor the ``colors`` setting, +The output methods in the previous section all honor the ``allow_ansi`` setting, which has three possible values: Never @@ -152,14 +152,17 @@ Terminal (the default value) poutput(), pfeedback(), and ppaged() do not strip any ANSI escape sequences when the output is a terminal, but if the output is a pipe or a file the escape sequences are stripped. If you want colorized - output you must add ANSI escape sequences, preferably using some python - color library like `plumbum.colors`, `colorama`, `blessings`, or - `termcolor`. + output you must add ANSI escape sequences using either cmd2's internal ansi + module or another color library such as `plumbum.colors`, `colorama`, or `colored`. Always poutput(), pfeedback(), and ppaged() never strip ANSI escape sequences, regardless of the output destination +Colored and otherwise styled output can be generated using the `ansi.style()` function: + +.. automethod:: cmd2.ansi.style + .. _quiet: |