diff options
| author | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
|---|---|---|
| committer | kotfu <kotfu@kotfu.net> | 2019-07-06 13:53:45 -0600 |
| commit | 9fe8e36a1e26569bdb47b8c361d077675a876af9 (patch) | |
| tree | 8e72372456ab4f50b61df443fdc1504afb6c1268 /docs/overview/integrating.rst | |
| parent | 6a5b9f8e13c9aed75ea23a23bad8ea0c64e90ff7 (diff) | |
| download | cmd2-git-9fe8e36a1e26569bdb47b8c361d077675a876af9.tar.gz | |
Add doc8 documentation style checking
- add dev dependency
- add doc8 to tasks.py
- fix all doc8 errors
Diffstat (limited to 'docs/overview/integrating.rst')
| -rw-r--r-- | docs/overview/integrating.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/overview/integrating.rst b/docs/overview/integrating.rst index 146e5e35..e28df1a7 100644 --- a/docs/overview/integrating.rst +++ b/docs/overview/integrating.rst @@ -9,13 +9,13 @@ include ``cmd2``. Make sure your ``setup.py`` includes the following:: ] The ``cmd2`` project uses `Semantic Versioning <https://semver.org>`_, which -means that any incompatible API changes will be release with a new major version -number. We recommend that you follow the advice given by the Python Packaging -User Guide related to `install_requires +means that any incompatible API changes will be release with a new major +version number. We recommend that you follow the advice given by the Python +Packaging User Guide related to `install_requires <https://packaging.python.org/discussions/install-requires-vs-requirements/>`_. By setting an upper bound on the allowed version, you can ensure that your -project does not inadvertently get installed with an incompatible future version -of ``cmd2``. +project does not inadvertently get installed with an incompatible future +version of ``cmd2``. Windows Considerations @@ -23,7 +23,8 @@ Windows Considerations If you would like to use :ref:`features/completion:Completion`, and you want your application to run on Windows, you will need to ensure you install the -``pyreadline`` package. Make sure to include the following in your ``setup.py``:: +``pyreadline`` package. Make sure to include the following in your +``setup.py``:: install_requires=[ 'cmd2>=1,<2', |