Merge pull request #898 from benoitc/fix-896

Add documentation about gunicorn/config.py.
This commit is contained in:
Benoit Chesneau 2014-09-23 10:12:40 +02:00
commit c56a9ee266
3 changed files with 8 additions and 2 deletions

View File

@ -60,6 +60,10 @@ test suite on your branch before submitting a pull request.
Make sure you include relevant updates or additions to documentation Make sure you include relevant updates or additions to documentation
when creating or modifying features. when creating or modifying features.
If you are adding a new configuration option or updating an existing one,
please do it in `gunicorn/config.py`, then run `make -C docs html` to update
`docs/source/settings.rst`.
Write clean code. Write clean code.
Pull requests descriptions should be as clear as possible and include a Pull requests descriptions should be as clear as possible and include a

View File

@ -1,6 +1,7 @@
.. _settings: .. _settings:
.. Please update gunicorn/config.py instead.
Settings Settings
======== ========

View File

@ -3,6 +3,8 @@
# This file is part of gunicorn released under the MIT license. # This file is part of gunicorn released under the MIT license.
# See the NOTICE for more information. # See the NOTICE for more information.
# Please remember to run "make -C docs html" after update "desc" attributes.
import copy import copy
import grp import grp
import inspect import inspect
@ -457,7 +459,6 @@ def get_default_config_file():
return None return None
# Please remember to run "make html" in docs/ after update "desc" attributes.
class ConfigFile(Setting): class ConfigFile(Setting):
name = "config" name = "config"
section = "Config File" section = "Config File"