summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* cmdloop now checks to see if it is running in the main thread before ↵Todd Leonhardt2018-10-211-0/+4
| | | | attempting to register a signal handler for SIGINT
* Deleted Cmd.colorize() method and Cmd._colorcodes dictionary which were ↵Todd Leonhardt2018-10-181-3/+0
| | | | deprecated in 0.9.5
* Documentation updatesKevin Van Brunt2018-10-121-3/+1
|
* Added warning to documentation about how help_foo won't be called for ↵Todd Leonhardt2018-10-061-2/+10
| | | | | | | command foo if it uses an argparse decorator Also: - Renamed argparse_example.py to decorator_example.py
* Added documentation stating that parsers passed to argparse decorators need ↵Todd Leonhardt2018-10-061-2/+14
| | | | | | | to be unique Also: - Modified table_display.py to demonstrate a workaround
* Merge branch 'macro' into argparse_conversionKevin Van Brunt2018-09-271-8/+45
|\
| * Documented macrosKevin Van Brunt2018-09-271-8/+45
| |
* | Merge branch 'macro' into argparse_conversionKevin Van Brunt2018-09-262-12/+32
|\ \ | |/
| * Merged alert_printer stuff from master and resolved conflictsTodd Leonhardt2018-09-251-0/+30
| |\
| * \ Merged master and resolved conflicts in CHANGELOGTodd Leonhardt2018-09-252-52/+28
| |\ \
| * \ \ Merged master into colorize branchTodd Leonhardt2018-09-121-7/+36
| |\ \ \
| * | | | Fixed unit test failuresTodd Leonhardt2018-09-041-2/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixed following unit test failures: - Doc build failure due to Sphinx warnings - Windows unit test failures related to colorize (hopefully)
| * | | | Merged master in and resolved conflictsTodd Leonhardt2018-09-041-0/+7
| |\ \ \ \ | | | | | | | | | | | | | | | | | | @kotfu - I hope this doesn't screw you up, but I wanted to minimize some of the merge pain that will likely be coming up soon
| * | | | | First pass at improved colorizingkotfu2018-08-112-6/+23
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | - colors setting now allows Always, Terminal, Never values - poutput() and perror() honor these new settings
| * | | | | Update help for ‘quiet’ setting.kotfu2018-08-111-7/+9
| | | | | |
* | | | | | First steps in converting all commands to argparseKevin Van Brunt2018-09-261-7/+3
| |_|_|_|/ |/| | | |
* | | | | Addressing code review commentsKevin Van Brunt2018-09-251-2/+2
| | | | |
* | | | | Added more examples and documentationKevin Van Brunt2018-09-251-2/+9
| | | | |
* | | | | Merge branch 'master' into alert_printerTodd Leonhardt2018-09-252-52/+28
|\ \ \ \ \ | | |_|_|/ | |/| | |
| * | | | Deleted the hook methods which were deprecated in the previous releaseTodd Leonhardt2018-09-252-52/+28
| | |_|/ | |/| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | The following methods of cmd2.Cmd have been deleted: - preparse - postparsing_precmd - postparsing_postcmd The new application lifecycle hook framework allows for registering callbacks to be called at various points in the application lifecycle and is more powerful and flexible than the old system of fixed hook methods.
* | | | Made async stuff publicKevin Van Brunt2018-09-251-2/+2
| | | |
* | | | Documented async functionsKevin Van Brunt2018-09-241-0/+23
|/ / /
* | | Docstring updatesKevin Van Brunt2018-09-091-6/+6
| | |
* | | Added/updated documentation for `Statement`kotfu2018-09-091-1/+30
| |/ |/|
* | Added way of returning a non-zero exit code to the shellTodd Leonhardt2018-08-231-0/+7
|/
* Removed non-working Module Index link from the main Sphinx docs pageTodd Leonhardt2018-07-312-6/+3
| | | | | | | | | Also: * Improved Sphinx build options in Makefile and via invoke by adding the following options: * -n : nit-picky mode, warn about all missing references * -v : increase verbosity (can be repeated) * -W : turn warnings into errors * -T : show full traceback on exception
* Fix Sphinx warning due to _static directoryTodd Leonhardt2018-07-301-1/+1
| | | | | Also: - Made alias_startup.py example robust as to what directory it is launched from
* Remove docs/requirements.txt which should no longer be usedkotfu2018-07-301-5/+0
| | | | Slowly trying to reduce the number of places we have dependencies specified. The documentation building processes for both `tox -e docs` and readthedocs.org should now use the dependencies specified in `setup.py`.
* We now must install cmd2 in place for readthedocs to workkotfu2018-07-301-0/+1
| | | | Attempted fix for #483
* Merge branch 'master' into run_at_invocationTodd Leonhardt2018-07-291-5/+6
|\
| * Use setuptools_scm for version numberskotfu2018-07-291-5/+6
| |
* | Add example and documentation for #452kotfu2018-07-291-21/+101
|/
* Add missing dependency on attrs to docs/requirements.txt to fix Sphinx autodocTodd Leonhardt2018-07-271-0/+1
|
* Fix documentation in regards to requirements on Python 3.4Todd Leonhardt2018-07-171-3/+3
| | | | Added typing backport dependency for Python 3.4
* Fix erroneous indication that ‘precmd()’ and ‘postcmd()’ are deprecatedkotfu2018-07-161-4/+0
|
* Started updating CHANGELOGTodd Leonhardt2018-07-162-2/+6
| | | | | | Also: - Bumped version to 0.9.4 - Updated info in Readme and Sphinx docs to reflect new dependency on attrs
* Fix typo.kotfu2018-07-151-3/+4
|
* Update description of command loopkotfu2018-07-152-25/+32
|
* preloop() and postloop() should not have been shown as deprecatedkotfu2018-07-121-10/+8
|
* Fix a couple minor typos in hooks.rstTodd Leonhardt2018-07-111-3/+3
|
* Merge branch 'master' into plugin_functionskotfu2018-07-052-2/+2
|\
| * Bumped version to 0.9.3 now that 0.9.2 release is outTodd Leonhardt2018-06-281-1/+1
| |
| * Bump version to 0.9.2 in preparation for releaseTodd Leonhardt2018-06-281-1/+1
| |
| * Deprecated CmdResult helper class and promoted CommandResultTodd Leonhardt2018-06-231-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | These classes are subtly different, particularly in terms of their truthiness. CmdResult - attributes: out, err, war - truthy: if err is falsy CommandResult - attributes: stdout, stderr, data - truthy: if err is falsy AND data is not None So CmdResult was oriented to provide essentially info, error, and warning messages to the user (typically as stirngs), whereas CommandResult is geared towards providing info and error messages to the user as strings in addition to data to the user in a command-specific format which is arbitrary other than it should never be None if the command succeeds.
* | Add command finalization hookskotfu2018-07-051-0/+2
| |
* | Postcommand hooks implementedkotfu2018-06-221-11/+12
| |
* | Revised postparsing hookskotfu2018-06-211-19/+25
| |
* | Formating and light editingkotfu2018-06-031-23/+36
| |
* | Precommand hooks now check typing of passed callableskotfu2018-06-031-11/+22
| |
* | Begin converting precmd to passing and returning a data objectkotfu2018-06-031-3/+11
| |