summaryrefslogtreecommitdiff
path: root/docs/api
Commit message (Collapse)AuthorAgeFilesLines
* Fixed issue where quoted redirectors and terminators in aliases and macros ↵Kevin Van Brunt2020-09-301-0/+4
| | | | | | were not being restored when read from a startup script.
* Updated documentation with more explicit discussions on testingEric Lin2020-08-202-0/+11
| | | | Added unit test to verify command name validation updates.
* Verify that a completer function is defined in a CommandSet beforeEric Lin2020-08-061-0/+3
| | | | | | | | | | passing it a CommandSet instance. Search for a CommandSet instance that matches the completer's parent class type.` Resolves Issue #967 Renamed isolated_tests directory to tests_isolated for better visual grouping. Added some exception documentation
* Fixes to sphinx generationEric Lin2020-08-042-0/+6
|
* Added SkipPostcommandHooks exception and made Cmd2ArgparseError inherit from it.Kevin Van Brunt2020-05-072-13/+26
| | | | Both exception classes have been added to the public API.
* Updating documentation for table creationKevin Van Brunt2020-04-221-0/+1
|
* Updated docsKevin Van Brunt2020-04-223-0/+37
|
* The continuation_prompt attribute was declared twice in cmd.rst - this fixes ↵Todd Leonhardt2020-04-081-5/+1
| | | | and consolidates that
* Update scripting docs. Closes #765.kotfu2020-02-281-0/+6
|
* Update history documentationkotfu2020-02-241-1/+1
|
* Revise version statementkotfu2020-02-241-1/+1
|
* Move list sorting from completion to misckotfu2020-02-241-6/+6
|
* Revise table of contents to include a description of each modulekotfu2020-02-243-8/+37
|
* Clarify that the API documentation is the public API.kotfu2020-02-221-0/+13
|
* Add py_bridge API documentationkotfu2020-02-222-0/+6
|
* Instead of using automodule, only document public api functionskotfu2020-02-221-1/+74
|
* Add argparse stuff to apikotfu2020-02-223-0/+12
|
* Revisions and improvements for hooks and pluginskotfu2020-02-221-2/+18
|
* plugin and hook documentation updateskotfu2020-02-204-1/+53
| | | | | | - add api documentation for plugin data classes - update hook and plugin documentation to link to now documented api classes
* Add history api documentationkotfu2020-02-203-1/+26
|
* Merge branch 'master' into api_docskotfu2020-02-202-5/+0
|\ | | | | | | | | | | | | | | # Conflicts: # CHANGELOG.md # cmd2/__init__.py # cmd2/decorators.py # docs/api/utility_functions.rst
| * Fixed docs errorKevin Van Brunt2020-02-201-1/+1
| |
| * Moved custom cmd2 exceptions to a separate file and removed them from public APITodd Leonhardt2020-02-182-5/+0
| |
* | Add API documentation for constantskotfu2020-02-152-0/+30
| |
* | Finish attribute documentation for Statement classkotfu2020-02-141-5/+30
| |
* | Add documentation of multiline_command attributekotfu2020-02-141-0/+5
| |
* | Remove separate files for utility functions and classeskotfu2020-02-143-6/+0
| |
* | Add documentation for parsing classeskotfu2020-02-143-7/+48
| |
* | Merge branch 'api_docs' of https://github.com/python-cmd2/cmd2 into api_docskotfu2020-02-101-2/+14
|\ \ | |/
| * Updated Sphinx documentation related to promptTodd Leonhardt2020-02-081-2/+14
| |
* | Begin process of combining utils api docs into a single documentkotfu2020-02-104-66/+6
| |
* | Title decorator documentation by package namekotfu2020-02-091-2/+2
|/
* EmbeddedConsoleExit should not be part of the public apikotfu2020-02-061-2/+0
|
* Add documentation of __init__ methodkotfu2020-02-061-0/+2
|
* Merge branch 'master' into doc_streamlinekotfu2020-02-062-2/+4
|\ | | | | | | | | # Conflicts: # docs/features/settings.rst
| * Documentation updateskotfu2020-02-051-0/+4
| |
| * Fixed doc build and updated READMETodd Leonhardt2020-02-041-2/+0
| |
* | Clean up class and method referenceskotfu2020-02-053-6/+6
|/ | | | | - In docs/api/cmd.rst, the `cmd2.Cmd` class was defined as `cmd2.cmd2.Cmd`, which required the extraneous `cmd2` every time we referenced it. This extra `cmd2` is no longer required. - always refer to a bare cmd2 using ``cmd2`` per our documentation conventions
* Updating unit tests and docsKevin Van Brunt2020-01-201-0/+2
|
* Move settable documentation from source code to api docskotfu2020-01-141-0/+8
|
* Add documentation for default_errorkotfu2020-01-141-0/+3
|
* Merge branch 'master' into generating_output_docsTodd Leonhardt2020-01-091-1/+7
|\ | | | | | | | | | | # Conflicts: # docs/features/generating_output.rst # docs/features/settings.rst
| * Fixed doc generation errorsKevin Van Brunt2019-12-091-1/+7
| |
* | Show various attribute documentation approaches for #821kotfu2019-11-291-1/+3
| |
* | Show various options for documenting attributeskotfu2019-11-291-0/+4
| |
* | Documentation for colored output #765kotfu2019-11-232-0/+6
|/
* Fixed building of docsKevin Van Brunt2019-10-312-5/+5
|
* Alphabetized feature listTodd Leonhardt2019-07-061-1/+1
|
* Added autoclass documentation for cmd2.Cmd in cmd.rstTodd Leonhardt2019-07-061-0/+3
| | | | This required whitespace tweaks to a number of docstrings.
* Added a walkthrough of constructing a simple application to the overviewkotfu2019-07-052-4/+4
| | | | For #709
View Lorry Controller Status