summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Removed dash from 'tab complete' stringKevin Van Brunt2020-02-138-16/+16
|
* Overhauling tab completion examplesKevin Van Brunt2020-02-122-7/+6
|
* Added caveatTodd Leonhardt2020-02-091-1/+3
|
* Updated Sphinx docs about helpTodd Leonhardt2020-02-091-11/+61
|
* Updated Sphinx documentation related to promptTodd Leonhardt2020-02-083-20/+51
|
* Merge branch 'master' into color_autocompleteTodd Leonhardt2020-02-0619-87/+68
|\
| * EmbeddedConsoleExit should not be part of the public apikotfu2020-02-061-2/+0
| |
| * Fix redundant declaration of cmd2.Cmd.__init__ methodkotfu2020-02-061-3/+1
| |
| * Add documentation of __init__ methodkotfu2020-02-061-0/+2
| |
| * Merge branch 'master' into doc_streamlineTodd Leonhardt2020-02-068-25/+30
| |\ | | | | | | | | | | | | # Conflicts: # docs/features/settings.rst
| * | Clean up class and method referenceskotfu2020-02-0519-80/+64
| | | | | | | | | | | | | | | - 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
* | | Having two parallel datastructures each for foreground and background colors ↵Todd Leonhardt2020-02-061-4/+3
| |/ |/| | | | | | | | | felt really clunky - now we just have one The Enum classes are now smart and deal with it all.
* | Fix flake8 errors in doc configTodd Leonhardt2020-02-051-3/+0
| |
* | Documentation updateskotfu2020-02-053-12/+20
| |
* | Updated documentationKevin Van Brunt2020-02-051-1/+1
| |
* | Updated help textKevin Van Brunt2020-02-051-3/+3
| |
* | Added cmd2.utils.Settable to the cmd2 namespace and updated examples and docsTodd Leonhardt2020-02-044-8/+11
| |
* | Fixed doc build and updated READMETodd Leonhardt2020-02-041-2/+0
|/
* Minor grammar fixTodd Leonhardt2020-01-291-3/+3
|
* Addressed PR commentsTodd Leonhardt2020-01-291-6/+17
|
* Updated docs on integrating with various operating system featuresTodd Leonhardt2020-01-292-31/+87
|
* Attempt to make "help -v" more discoverable by changing the default help textTodd Leonhardt2020-01-293-6/+8
|
* Flushed out multiline command documentationTodd Leonhardt2020-01-281-0/+14
|
* Renamed locals_in_py to self_in_pyTodd Leonhardt2020-01-272-4/+4
| | | | This more accurately reflects what it controls
* Made three public attributes of cmd2.Cmd no longer settable at runtime by ↵Todd Leonhardt2020-01-277-39/+26
| | | | | | | | | end users The 3 attributes are: - continuation_prompt - locals_in_py - prompt
* Deleted info on the instance attributes which might only be used in ↵Todd Leonhardt2020-01-271-19/+2
| | | | extremely rare circumstances
* Updated documentationKevin Van Brunt2020-01-272-7/+11
|
* Flushed out initialization documentationTodd Leonhardt2020-01-261-0/+97
| | | | | Also: - Rearranged some instance attributes in Cmd class to make it clear that they were not used by tab-completion functions.
* Updated commentTodd Leonhardt2020-01-261-9/+10
|
* Improved example in initialiation docsTodd Leonhardt2020-01-261-2/+14
|
* Fixed broken links in Sphinx docsTodd Leonhardt2020-01-265-11/+11
| | | | | | Also: - Added a "linkcheck" task to the invoke tasks _ Use pseudoterminals for invoke tasks with colored output so that we can see the color when using invoke
* Cleanup MANIFEST.in to reduce what gets put in package downloadable from PyPITodd Leonhardt2020-01-242-7/+0
| | | | | | Also: - Trivial simplification in setup.py - Removed redundant copyright.rst file from docs since everything falls under the MIT License and there is already copyright statement in docs
* Flushed out documentation on built-in commandsTodd Leonhardt2020-01-231-3/+73
|
* Fix doc8 line length violations committed in prevoius PRTodd Leonhardt2020-01-202-16/+19
|
* Updating unit tests and docsKevin Van Brunt2020-01-201-0/+2
|
* Updating some doc textKevin Van Brunt2020-01-161-2/+9
|
* Updating some doc textKevin Van Brunt2020-01-161-6/+14
|
* Updating some doc textKevin Van Brunt2020-01-161-2/+2
|
* Updating some doc textKevin Van Brunt2020-01-161-1/+1
|
* Fix doc8 errorkotfu2020-01-151-3/+3
|
* Clarify comment style for module data members and class attributeskotfu2020-01-151-0/+6
|
* Clarify how to document instance attributeskotfu2020-01-151-0/+14
|
* Fix document rendering errorkotfu2020-01-151-1/+1
|
* Revise allow_style and colored output documentationkotfu2020-01-142-88/+64
|
* Move settable documentation from source code to api docskotfu2020-01-141-0/+8
|
* Add shell command, and show how to remove builtin commandskotfu2020-01-141-8/+35
|
* Add documentation for default_errorkotfu2020-01-141-0/+3
|
* Updates for allow_ansi -> allow_stylekotfu2020-01-141-2/+2
|
* Merge branch 'master' into generating_output_docsTodd Leonhardt2020-01-095-13/+42
|\ | | | | | | | | | | # Conflicts: # docs/features/generating_output.rst # docs/features/settings.rst
| * Update copyright through 2020 and restore documentation copyright to MIT licenseTodd Leonhardt2020-01-092-4/+3
| | | | | | | | During recent work to upgrade the format of the Sphinx documentation, the license the docs are copyright under was accidentally changed from MIT to CreativeCommons. This restores the documentation to be under an MIT license so there is a single license governing both code and documentation.
View Lorry Controller Status