summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Address fact that typing.Deque wasn't defined prior to 3.5.4Todd Leonhardt2020-07-131-0/+1
|
* replace pkg_resources with importlib.metadataDoug Hellmann2020-07-121-2/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | Importing pkg_resources has a side-effect of scanning every installed distribution on sys.path to load the metadata, especially the entry points defined in the packages. This can have a significant launch-time cost for command line applications when there are a lot of distributions to scan. Since cmd2 is only using pkg_resources to find the version of the installed package, pkg_resources can be replaced with importlib.metadata. The implementation in the new library is significantly faster because it goes immediately to the metadata file for the requested distribution, instead of scanning all of them. There are also no import-time side-effects. importlib.metadata is a new standard library module starting with python 3.8. For earlier versions, a compatible library has been released to PyPI as 'importlib_metadata'. This change adds the new dependency with a qualifier so that it is only applied to older versions of python, and then updates the places that were importing pkg_resources to look for the different versions of the new library instead. The documentation configuration is changed to import cmd2 itself to get its version, since the package has to be installed for the metadata to be available anyway. Signed-off-by: Doug Hellmann <doug@doughellmann.com>
* Fixed command finalization exampleKevin Van Brunt2020-07-071-1/+1
|
* Move line that seemed out of place at the very end to before the "advanced" ↵Todd Leonhardt2020-06-271-3/+3
| | | | section
* Further additions to pyscript documenntation for Issue #644Eric Lin2020-06-224-0/+114
|
* Updated docsKevin Van Brunt2020-05-282-1/+20
|
* 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.
* Added info on semantic versioning and branching strategy to CONTRIBUTING.mdTodd Leonhardt2020-04-241-2/+1
| | | | | | | Also: - Added isort to Pipenv dev - Added setup.cfg to make it easy to run flake8, doc8, and isort directly from the command line without using invoke - Ran isort to sort includes
* Completion doc updatesKevin Van Brunt2020-04-231-1/+2
|
* More completion doc updatesKevin Van Brunt2020-04-231-2/+2
|
* Updated tab completion documentationKevin Van Brunt2020-04-231-3/+40
|
* Documented CompletionError classKevin Van Brunt2020-04-231-0/+18
|
* Fix doc8 whitespace issueTodd Leonhardt2020-04-231-1/+1
|
* Updating documentation for table creationKevin Van Brunt2020-04-223-0/+42
|
* Updated docsKevin Van Brunt2020-04-223-0/+37
|
* Fix documentation typo found in PR #915Todd Leonhardt2020-04-091-1/+1
|
* Fix extra space typoTodd Leonhardt2020-04-091-1/+1
|
* Added documentation about decorator order and updated an exampleTodd Leonhardt2020-04-092-0/+48
| | | | | Also: - Deal with warnings when building docs with Sphinx 3.0.0
* The continuation_prompt attribute was declared twice in cmd.rst - this fixes ↵Todd Leonhardt2020-04-081-5/+1
| | | | and consolidates that
* Ctrl-C now stops a running text script instead of just the current script ↵Kevin Van Brunt2020-03-262-6/+6
| | | | command
* Addressing PR feedback.kotfu2020-02-281-0/+9
|
* Merge branch 'master' into scripting_docskotfu2020-02-281-18/+24
|\
| * Revise completion docs. Fixes #800. Updates #765.kotfu2020-02-281-18/+24
| |
* | Update scripting docs. Closes #765.kotfu2020-02-283-17/+38
|/
* Add cross-references and linkskotfu2020-02-241-17/+13
|
* Remove extra newline and EOFkotfu2020-02-241-1/+0
|
* Update history documentationkotfu2020-02-242-7/+39
|
* 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
|
* Specify spacing when using autoclasskotfu2020-02-241-0/+15
|
* Clarify that the API documentation is the public API.kotfu2020-02-222-2/+18
|
* Add py_bridge API documentationkotfu2020-02-222-0/+6
|
* Instead of using automodule, only document public api functionskotfu2020-02-221-1/+74
|
* Add links to recently added API documentationkotfu2020-02-221-13/+14
|
* Add argparse stuff to apikotfu2020-02-225-11/+18
|
* Revisions and improvements for hooks and pluginskotfu2020-02-224-62/+97
|
* plugin and hook documentation updateskotfu2020-02-206-76/+141
| | | | | | - 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-203-11/+1
|\ | | | | | | | | | | | | | | # 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-183-11/+1
| |
* | 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 link to issue for more detail on how we determined our attribute ↵kotfu2020-02-141-0/+3
| | | | | | | | documentation approach
* | Add documentation for parsing classeskotfu2020-02-143-7/+48
| |
* | no - in tab-completionkotfu2020-02-141-1/+1
| |
* | Merge branch 'master' into api_docskotfu2020-02-149-33/+84
|\ \ | |/ | | | | | | | | # Conflicts: # cmd2/ansi.py # docs/features/completion.rst
View Lorry Controller Status