summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* 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
|
* Removed unused docs/pycon2010/ui directory.Todd Leonhardt2017-02-0511-934/+0
|
* Added doc _build dir to .gitignoreTodd Leonhardt2017-01-312-0/+4
|
* Added a couple notes in the docs:Todd Leonhardt2017-01-302-2/+19
| | | | | 1) Note about needing GNU Readline or equivalent for tab-completion to work 2) Note about behavior occurring when and empty line is entered is different from parent cmd module
* Various minor updates:Todd Leonhardt2017-01-293-11/+11
| | | | | | | | | - Updated .gitignore for code coverage result dirs from coverage and pytest-cov - Updated README.rst to include badge for latest docs from readthedocs.io - Updated setup.py to have updated info for the next time a release is made to PyPI - Documentation updates: - Bumped version in conf.py to 0.7 - Updated links in index.rst and alternatives.rst
* Updated a few dead links in the documentationTodd Leonhardt2016-12-111-9/+8
|
* Whitespace change to be mostly PEP8 compliantTodd Leonhardt2016-12-099-37/+97
|
* First stage of refactoring to support full simultaneous Python 2 and 3 ↵Todd Leonhardt2016-12-0915-204/+127
| | | | compatibility via use of the six module.
* Update version (Closes #22)Federico Ceratto2016-03-151-1/+1
|
* Marking for 0.6.8 release0.6.8Catherine Devlin2014-12-081-2/+2
|
* Indicate change in repository host to bitbucketCatherine Devlin2012-05-2645-0/+2794