summaryrefslogtreecommitdiff
path: root/docs/conf.py
Commit message (Collapse)AuthorAgeFilesLines
* Add black for automatic code formatTodd Leonhardt2021-01-311-20/+19
|
* 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>
* 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
* Added documentation about decorator order and updated an exampleTodd Leonhardt2020-04-091-0/+13
| | | | | Also: - Deal with warnings when building docs with Sphinx 3.0.0
* Show autodoc members in the same order as the source codekotfu2020-02-081-0/+5
|
* Fix flake8 errors in doc configTodd Leonhardt2020-02-051-3/+0
|
* Documentation updateskotfu2020-02-051-3/+0
|
* Update copyright through 2020 and restore documentation copyright to MIT licenseTodd Leonhardt2020-01-091-1/+1
| | | | 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.
* Add copyright links per comments in #712kotfu2019-07-061-1/+1
|
* Major overhaul of documentation structure for #709kotfu2019-07-021-2/+5
|
* Fix flake8 issuesTodd Leonhardt2018-12-061-1/+3
| | | | | | | | | | | | | | | | | | | | | | This commit contains a very large number of trivial changes in order to fix flake8 errors and warnings. Predominantly these are whitespace changes. Additionally, the build for Python 3.7 on TravisCI has been tweaked to fail if there are any flake8 errors using the following commandline: * flake8 . --count --ignore=E252 --max-complexity=31 --max-line-length=127 --show-source --statistics NOTE: In the future the max cyclomatic complexity should be lowered, but some improvements need to be made first. One flake8 error is being ignored entirely: * E252 missing whitespace around parameter equals * ignored because it doesn't correctly deal with default argument values after a type hint A few flake8 errors are being selectively ignored in certain files: * C901 fuction is too complex * ignored in argparse_completer.py because the complex code is an override of argparse complexity * E302 expected 2 blank lines after ... * ignored in all unit test files for convenience * F401 module imported but unused * ignored in cmd2/__init__.py because imports are for convenience of cmd2 developers and backwards compatibility * F821 undefined name * ignored in cmd2 script files which are intended to run only within cmd2 applications via pyscript where "app" and "cmd" are defined
* Fix Sphinx warning due to _static directoryTodd Leonhardt2018-07-301-1/+1
| | | | | Also: - Made alias_startup.py example robust as to what directory it is launched from
* Use setuptools_scm for version numberskotfu2018-07-291-5/+6
|
* Started updating CHANGELOGTodd Leonhardt2018-07-161-1/+1
| | | | | | Also: - Bumped version to 0.9.4 - Updated info in Readme and Sphinx docs to reflect new dependency on attrs
* Bumped version to 0.9.3 now that 0.9.2 release is outTodd Leonhardt2018-06-281-1/+1
|
* Bump version to 0.9.2 in preparation for releaseTodd Leonhardt2018-06-281-1/+1
|
* Bumped version to 0.9.2a for twine upload testing on test.pypi.orgTodd Leonhardt2018-05-301-1/+1
|
* Update version to 0.9.1 for #4210.9.1kotfu2018-05-281-1/+1
|
* Update version to 0.9.0.1 for #421kotfu2018-05-281-1/+1
|
* Update version to 0.9.1rc1 to try and fix #421kotfu2018-05-281-1/+1
|
* Merged master into delete_optparse branchTodd Leonhardt2018-04-151-2/+2
|\ | | | | | | | | Also: - Bumped version to 0.9.0
| * Preparation for 0.8.5 releaseTodd Leonhardt2018-04-131-1/+1
| | | | | | | | | | - Bumped version to 0.8.5 - Added details to CHANGELOG.md regarding recent changes
| * Preparing for 0.8.4 release0.8.4Kevin Van Brunt2018-04-101-1/+1
| |
* | Updated version to 0.8.5Todd Leonhardt2018-04-101-1/+1
| |
* | Deleted optparse code which had been previously deprecated in 0.8.0 releaseTodd Leonhardt2018-04-091-1/+1
|/ | | | | Also: - Bumped version to 0.8.4
* Updated version number of release0.8.3Kevin Van Brunt2018-04-091-1/+1
|
* Added table_display.pyTodd Leonhardt2018-03-141-1/+1
| | | | | | | | Added example showing how to display tabular data in a cmd2 application. Also: - Updated CHANGELOG with data on all PRs since last release - Bumped version to 0.8.2 in preparation for next release
* Added optional persistent readline history featureTodd Leonhardt2018-02-081-1/+1
| | | | | | | | | | | | - Including an example and info in the Sphinx docs Also: - Created CHANGELOG entry for 0.8.1 release - Added info to README about new sub-menu feature - Bumped version to 0.8.1 TODO: - Added a unit test for the persistent readline history feature
* Added links to docs and examples to CHANGELOG.mdTodd Leonhardt2018-01-201-2/+2
| | | | Also bumped version to 0.8.0.
* Updating version and changelog in preparation for minor bug fix realeaseTodd Leonhardt2018-01-041-1/+1
|
* Added fix for changes in pyperclip project structure in the most recent versionTodd Leonhardt2017-11-081-1/+1
| | | | | | | | | 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
* 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.
* 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
* Updated CHANGES and bumped version in preparation for 0.7.6 releaseTodd Leonhardt2017-08-021-1/+1
|
* Bump version to 0.7.5 (from 0.7.5a)0.7.5Todd Leonhardt2017-07-081-1/+1
|
* Bump version to 0.7.5aTodd Leonhardt2017-07-031-1/+1
|
* Mostly fix a bunch of spelling mistakes.Todd Leonhardt2017-03-131-18/+19
| | | | A few other miscellaneous minor tweaks for whitespace and such.
* Add six module to requirements for building docsTodd Leonhardt2017-02-121-3/+0
|
* 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-111-1/+1
| | | | | | | | 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
* docs now use the sphinx_rtd_theme.Todd Leonhardt2017-02-111-113/+78
| | | | 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/
* Various minor updates:Todd Leonhardt2017-01-291-2/+2
| | | | | | | | | - 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
* Whitespace change to be mostly PEP8 compliantTodd Leonhardt2016-12-091-37/+36
|
* First stage of refactoring to support full simultaneous Python 2 and 3 ↵Todd Leonhardt2016-12-091-1/+1
| | | | 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-261-0/+198
View Lorry Controller Status