summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Updated docs to make it more clear that you need to update shortcuts ↵Todd Leonhardt2017-11-092-6/+18
| | | | attribute before calling super class __init__
* Removed broken link from docs0.7.8Todd Leonhardt2017-11-081-2/+1
|
* Fixed incorrect http link in the READMETodd Leonhardt2017-11-081-1/+1
|
* Added fix for changes in pyperclip project structure in the most recent versionTodd Leonhardt2017-11-0822-729/+15
| | | | | | | | | Also included a number of minor maintenance updates: - Bumped version to 0.7.8 in preparation for upcoming release - Updated Readme.md to add link to slides from recent Florida PyCon talk about cmd2 - Updated documentation on integrating cmd2 with other event loops to use newer runcmds_plus_hooks() method instead of legacy onecmds_plus_hooks method which doesn't properly deal with load commands - Deleted old files which were used to prepare for a PyCon 2010 presentation - Updated ChangeLog regarding this bug fix
* Hopefully this fixes a bug which is causing autodoc to fail to add method ↵Todd Leonhardt2017-09-231-0/+1
| | | | | | | info on readthedocs I can build the docs locally and it works fine, but the autodoc part of Sphinx was failing on readthedocs - and it was failing due to pyperclip not being present
* Improved documentation for how a user can modify comment grammar/styleTodd Leonhardt2017-09-221-1/+2
| | | | | | | Also: - Added arg_print.py example to demonstrate this - Bumped version to 0.7.8a - Updated CHANGELOG
* Revise environment setting documentationkotfu2017-08-281-41/+33
|
* Updated CHANGELOG with some text regarding recent enhancements to transcript ↵Todd Leonhardt2017-08-221-1/+1
| | | | | | regexes Also bumped version from 0.7.7a to 0.7.7 in preparation for eventual next release.
* Clarify warnings about whitespaceJared Crapo2017-08-221-5/+6
|
* Documentation edits and revisionsJared Crapo2017-08-222-33/+28
|
* Revise and clean up documentationJared Crapo2017-08-213-31/+58
|
* regex implementation complete. Still a few bugs.Jared Crapo2017-08-211-0/+8
|
* Write documentation for revised transcription featureJared Crapo2017-08-213-24/+143
|
* Bump versions to 0.7.7aTodd Leonhardt2017-08-151-1/+1
| | | | This is to help distinguish latest code in GitHub from a version installed via pip from PyPI
* Replaced direct calls to self.stdout.write() with calls to self.poutput().Todd Leonhardt2017-08-081-0/+7
| | | | | | Modified implementation of poutput() to accept an optional "end" argument which can change the ending to something other than a newline or simply suppress adding a newline. Also added a try/except to catch BrokenPipeError exceptions which can occupoutputr if the subprocess output is being piped to closes before the command piping output to it is finished. Updated install docs to note that when using Python 2.7, the subprocess32 module should also be installed.
* Updated CHANGES and bumped version in preparation for 0.7.6 releaseTodd Leonhardt2017-08-021-1/+1
|
* Spelling of abbrev in Abbreviated commands section ksunden2017-07-161-1/+1
| | | From "abrev" to "abbrev"
* Bump version to 0.7.5 (from 0.7.5a)0.7.5Todd Leonhardt2017-07-081-1/+1
|
* Load command uses utf-8 encoding for opening files in Python 3 instead of ↵Todd Leonhardt2017-07-081-2/+8
| | | | | | OS-default This fixes a unit test bug where on Windows it was trying to load a utf-8 file as some other encoding starting with "cp".
* Updated Sphinx docsTodd Leonhardt2017-07-032-5/+5
| | | | Updated to reflect that the default value of abbrev is now False.
* Fixed a few bugs and examplesTodd Leonhardt2017-07-031-1/+0
| | | | | | | | | | | | | | Bug fixes: - case_insensitive is no longer a runtime-settable parameter, but it was still listed as such - Fixed a recursive loop bug when abbreviated commands are enabled and it could get stuck in the editor forever - Added additional command abbreviations to the "exclude from history" list - Fixed argparse_example.py and pirate.py examples Other changes: - Organized all attributes used to configure the ParserManager into a single location - Set the default value of "abbrev" to False (which controls whether or not abbreviated commands are allowed) - With good tab-completion of command names, using abbreviated commands isn't a particularly useful feature - And it can create problems
* Bump version to 0.7.5aTodd Leonhardt2017-07-031-1/+1
|
* Removed pause commandTodd Leonhardt2017-07-031-2/+0
| | | | | | It was pretty useless, it just printed a message and sat there and waited for the user to hit enter. It didn't feel like it belonged in a top-level framework. If a particular application wants this functionality, it is a 2 line change to add it back.
* Clarified a few points about optional ipy command in Sphinx docsTodd Leonhardt2017-07-031-5/+8
|
* Replaced clipboard copy and paste custom code with pyperclipTodd Leonhardt2017-06-301-0/+1
| | | | | | - Added a 3rd-party dependency on the pyperclip module TODO: Rigorous test on all OSes, particularly Linux systems without xclip
* Multiple changesTodd Leonhardt2017-06-281-2/+1
| | | | | | | | - Disabled TravisCI macOS builds because they are heavily backlogged - Removed a file which should never have been committed - Updated Sphinx docs to relect that the default_file_name settable parameter no longer exists - Fixed comment in a unit test - Fixed a unit test to use os.path.sep for cross-platform compatibility
* Updated documentation with info on tab completion of file system pathsTodd Leonhardt2017-06-142-1/+34
|
* Updated documentation and examplesTodd Leonhardt2017-06-142-1/+30
| | | | | | | | | Added information related to the new pyscript command. The old way of running Python scripts via "py run()" should be considered deprecated. The new "pyscript" command is superior in two significant ways: 1) It supports tab-completion of file system paths 2) It allows the user to pass command-line arguments to scripts
* Updated example transcript test and docsTodd Leonhardt2017-06-031-2/+0
| | | | Updated these to reflect that the list command has been removed
* Abbreviations are no longer accepted for multiline commandsTodd Leonhardt2017-05-201-0/+5
| | | | | | Due to the way the parsing logic works for multiline commands, abbreviations didn't function properly with mutliline commands. So to avoid confusion, this commit deals with this issue by simply disallowing abbreviations for multiline commands altogether. A warning has been added to the section on abbreviations in the documentation to hopefully make this clear for users.
* Documentation updateTodd Leonhardt2017-05-111-1/+1
|
* Mostly fix a bunch of spelling mistakes.Todd Leonhardt2017-03-1312-28/+37
| | | | A few other miscellaneous minor tweaks for whitespace and such.
* Documentation updatesTodd Leonhardt2017-03-124-8/+86
| | | | | | - Added a new section on application life cycle and hook methods - Moved a warning to a more appropriate location - Added a note about using allow_redirection to disable output redirection and pipes
* Added an example for how conditional control flow of a cmd2 application can ↵Todd Leonhardt2017-03-111-0/+7
| | | | be achieved via the py command and python scripts.
* Updated the Sphinx docsTodd Leonhardt2017-03-062-0/+74
| | | | | | Added info on how to run cmd2 applications in a manner where cmd2 doesn't own the main loop so that the apps can be integrated with event loops.
* Fix a typo in the docsTodd Leonhardt2017-03-041-1/+1
|
* Added info to CHANGES.rst on what bugs have been fixed so far this release.Todd Leonhardt2017-03-041-0/+26
| | | | | | Fixed a bug where the allow_cli_args attribute wasn't properly preventing OptParse from prasing the args looking for "-t" or "--test" for transcript testing. Added an example of using Argparse with cmd2.
* Updated docs to discuss the new optional "ipy" command.Todd Leonhardt2017-02-181-0/+36
|
* Fixed a minor typoTodd Leonhardt2017-02-181-1/+2
|
* Updated install instructions to include how to install from GitHub using pip.Todd Leonhardt2017-02-181-4/+42
|
* Added installation instructions to documentation.Todd Leonhardt2017-02-122-0/+85
| | | | Also reorganized the GitHub README.rst front-page.
* Documentation fixes and updatesTodd Leonhardt2017-02-121-2/+23
| | | | | | - Fixed optparse links - Added note about plans to replace optparse with argparse - Added subsection about the functions which control argument parsing for commands with flags
* Documentation updatesTodd Leonhardt2017-02-126-48/+51
| | | | | | | | | | | Sphinx documenation updates, including: - Extensively re-wrote the "alternatives to cmd2" section as it was many years out of date - Reworded a few humorous sections in an attempt to be more professional - Removed reference to command synonyms/aliases which no longer exist - Added more detail in a couple places - Minor rewording and bugfixes throughout Also added a note to cmd2.py about the expected values for doctest only working for Python 2.7.
* Add six module to requirements for building docsTodd Leonhardt2017-02-122-3/+1
|
* Adding requirements.txt to doc section to try to fix autodoc on readthedocsTodd Leonhardt2017-02-121-0/+1
|
* Fixed doc conf.py so it correctly sets PYTHONPATH for autodoc feature.Todd Leonhardt2017-02-121-4/+10
|
* Refactored to move all cmd2.Cmd class member variables to beginning.Todd Leonhardt2017-02-112-26/+28
| | | | | | | | Also: - Added locals_in_py to settable parameters to match documentation. - Added pycon2010 slides back into doc build since they are referenced with :doc: - Fixed some references in the documentation - Updated unit tests accordingly
* Updated doc links to point to Python 3 docs for cmd module.Todd Leonhardt2017-02-115-7/+8
| | | | Also fixed references to the Script files section.
* docs now use the sphinx_rtd_theme.Todd Leonhardt2017-02-112-114/+79
| | | | The docs now use the custom HTML theme from Read the Docs so that when they are built locally they look the same as they will at https://cmd2.readthedocs.io/en/latest/
* Removed some unused bash scripts which were for uploading stuff to PyCon 2010Todd Leonhardt2017-02-053-11/+0
|
View Lorry Controller Status