summaryrefslogtreecommitdiff
path: root/docs/index.rst
Commit message (Collapse)AuthorAgeFilesLines
* Cleanup MANIFEST.in to reduce what gets put in package downloadable from PyPITodd Leonhardt2020-01-241-1/+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
* Fixed broken links in README.md due to documentation reorganizationTodd Leonhardt2019-07-181-6/+6
| | | | | | Also: - Moved Examples before API Reference in overall documentation index - Added an example project
* Integrate ‘parameter changes’ document into new doc structurekotfu2019-07-161-15/+0
|
* Integrate the ‘integrating’ documentation into the new structurekotfu2019-07-161-2/+0
|
* Integrate the unfreefeatures legacy documentationkotfu2019-07-161-2/+0
|
* Integrate freefeatures into new doc structurekotfu2019-07-161-2/+0
|
* Lots of work on the migrating documentation for #719kotfu2019-07-141-0/+3
|
* Started filling in some missing stuff in the new documentation structureTodd Leonhardt2019-07-071-6/+0
|
* Add copyright links per comments in #712kotfu2019-07-061-0/+1
|
* Fix headerskotfu2019-07-031-8/+16
|
* Revise menu structurekotfu2019-07-031-52/+14
| | | | | - collapse menu structure in sidebar so not everything is always shown - updates to Getting Started section
* Skeleton doc structure complete for #709kotfu2019-07-021-0/+13
|
* Major overhaul of documentation structure for #709kotfu2019-07-021-46/+95
|
* Deprecate support for Python 3.4 and begin testing with Python 3.8 betaTodd Leonhardt2019-06-141-1/+1
|
* Removed non-working Module Index link from the main Sphinx docs pageTodd Leonhardt2018-07-311-5/+2
| | | | | | | | | Also: * Improved Sphinx build options in Makefile and via invoke by adding the following options: * -n : nit-picky mode, warn about all missing references * -v : increase verbosity (can be repeated) * -W : turn warnings into errors * -T : show full traceback on exception
* Removed reference to Python 2 and 2.7 in some sections of the documentationTodd Leonhardt2018-04-151-1/+1
|
* Added link to video of Florida Pycon 2017 presentation on cmd2Todd Leonhardt2018-03-231-2/+1
| | | | Link added to both README and Resources section of Sphinx docs.
* Added back in preference for gnureadline if it is presentTodd Leonhardt2018-03-211-3/+4
| | | | | | Now that the crash bug in the gnureadline Python module which statically links against a compatible version of GNU Readline has been fixed for macOS, we added back in the top-level import boilerplate to prefer it if it is available. Also updated some documentation in relation to getting readline installed for macOS.
* Write documentationkotfu2018-01-071-1/+1
|
* Merge branch 'master' of github.com:python-cmd2/cmd2 into argparsekotfu2018-01-071-1/+1
|\
| * Disabled Python 3.7-dev build in Travis CITodd Leonhardt2018-01-041-1/+1
| | | | | | | | | | | | | | There are a couple unit test failures with Python 3.7-dev that we will need to look into at some point, so I disabled that build for now. Updated all documentation to reflect that cmd2 is support on Python 2.7 and 3.4+. Official support for Python 3.3 has been abandoned due to no longer having support to test on that platform on Travis CI.
* | Merge branch 'master' of https://github.com/python-cmd2/cmd2 into argparseJared Crapo2017-12-111-4/+2
|\ \ | |/
| * Updated docs to make it more clear that you need to update shortcuts ↵Todd Leonhardt2017-11-091-1/+0
| | | | | | | | 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-081-3/+3
| | | | | | | | | | | | | | | | | | 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
* | Plan and first working code for argparse decoratorJared Crapo2017-12-111-0/+1
|/
* Revise and clean up documentationJared Crapo2017-08-211-1/+1
|
* Write documentation for revised transcription featureJared Crapo2017-08-211-0/+1
|
* Updated documentation with info on tab completion of file system pathsTodd Leonhardt2017-06-141-1/+3
|
* Documentation updateTodd Leonhardt2017-05-111-1/+1
|
* Documentation updatesTodd Leonhardt2017-03-121-0/+1
| | | | | | - 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
* Updated the Sphinx docsTodd Leonhardt2017-03-061-0/+1
| | | | | | 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.
* Added installation instructions to documentation.Todd Leonhardt2017-02-121-0/+1
| | | | Also reorganized the GitHub README.rst front-page.
* Documentation updatesTodd Leonhardt2017-02-121-1/+1
| | | | | | | | | | | 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.
* Updated doc links to point to Python 3 docs for cmd module.Todd Leonhardt2017-02-111-3/+2
| | | | Also fixed references to the Script files section.
* docs now use the sphinx_rtd_theme.Todd Leonhardt2017-02-111-1/+1
| | | | 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/
* Added doc _build dir to .gitignoreTodd Leonhardt2017-01-311-0/+2
|
* Added a couple notes in the docs:Todd Leonhardt2017-01-301-0/+7
| | | | | 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-291-3/+3
| | | | | | | | | - 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
|
* Indicate change in repository host to bitbucketCatherine Devlin2012-05-261-0/+72
View Lorry Controller Status