artin/cement
1
0
Fork 0
mirror of https://github.com/datafolklabs/cement.git synced 2026-02-06 14:26:55 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup Doc

Browse Source
This commit is contained in:
BJ Dierkes 2016-01-11 11:31:05 -06:00
parent 45677fdbbc
commit 87927320a3
6 changed files with 16 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -36,7 +36,7 @@ Cement core features include (but are not limited to):
* 100% test coverage using Nose*
* 100% PEP8 compliant using `pep8` and `autopep8` tools
* Extensive Sphinx documentation
* Tested on Python 2.6, 2.7, 3.2, 3.3, and 3.4
* Tested on Python 2.6, 2.7, 3.2, 3.3, 3.4, and 3.5
*Note that argparse is required as an external dependency for Python < 2.7
and < 3.2. Additionally, some optional extensions that are shipped with the
@ -53,7 +53,7 @@ More Information
* PYPI: http://pypi.python.org/pypi/cement/
* SITE: http://builtoncement.com/
* T-CI: https://travis-ci.org/datafolklabs/cement
* HELP: cement@librelist.org - #cement
* HELP: cement@librelist.org - #cement - gitter.im/datafolklabs/cement
License

3
doc/source/conf.py
View File

@ -61,8 +61,7 @@ MOCK_MODULES = [
'colorlog',
'argcomplete',
]
# for mod_name in MOCK_MODULES:
# sys.modules[mod_name] = Mock()
sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

6
doc/source/examples/bash_auto_completion.rst
View File

@ -15,6 +15,12 @@ Note that, in the future, we would love to include some form of
following is a working example that can be used as a model for adding BASH
auto-completion to your app.
Update: As of Cement 2.7.x, the
:ref:`Argcomplete Framework Extension<cement.ext.ext_argcomplete>` can be
used as an alternative to this example. Both are viable options though
this route is much more manual, and the Argcomplete route might not fit your
needs.
Example Cement App
^^^^^^^^^^^^^^^^^^

1
doc/source/examples/index.rst
View File

@ -8,7 +8,6 @@ with Cement.
:maxdepth: 1
app_version
append_config_path
multiple_stacked_controllers
abstract_base_controllers
controllers_with_same_label

2
doc/source/index.rst
View File

@ -46,7 +46,7 @@ Core features include (but are not limited to):
* 100% test coverage using Nose
* 100% PEP8 compliant using `pep8` and `autopep8` tools
* Extensive Sphinx documentation
* Tested on Python 2.6, 2.7, 3.2, 3.3, and 3.4
* Tested on Python 2.6, 2.7, 3.2, 3.3, 3.4, 3.5
*Note that argparse is required as an external dependency for Python < 2.7
and < 3.2. Additionally, some optional extensions that are shipped with

11
doc/source/upgrading.rst
View File

@ -15,9 +15,9 @@ release, as noted in the :ref:`ChangeLog <changelog>`.
TypeError: render() got an unexpected keyword argument
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
In Cement 2.6, output handlers were not required to access ``**kwargs``,
however due to a design flaw this is now required to allow applications to
mix different types of output handlers that support different features.
In Cement 2.6, output handlers were not required to accept ``**kwargs``,
however this is now required to allow applications to mix different types of
output handlers together that might support different features/usage.
After upgrading to Cement 2.8, you might receive something similar to the
following exception:
@ -28,8 +28,9 @@ following exception:
This would most likely be the case becase you have created your own custom
output handler, or are using a third-party output handler. The fix is to
simply add ``**kwargs`` to the end of the `render()` method.
output handler, or are using a third-party output handler that has not been
updated to support Cement 2.8 yet. The fix is to simply add ``**kwargs`` to
the end of the `render()` method.
For example: