From 5536a5fd73fb18642365354ce00a369da0ffea03 Mon Sep 17 00:00:00 2001 From: Berker Peksag Date: Tue, 23 Sep 2014 10:31:35 +0300 Subject: [PATCH] Add documentation about gunicorn/config.py. Fixes #896. --- CONTRIBUTING.md | 4 ++++ docs/source/settings.rst | 3 ++- gunicorn/config.py | 3 ++- 3 files changed, 8 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 30c13c98..49130a0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -60,6 +60,10 @@ test suite on your branch before submitting a pull request. Make sure you include relevant updates or additions to documentation 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. Pull requests descriptions should be as clear as possible and include a diff --git a/docs/source/settings.rst b/docs/source/settings.rst index 172a603b..a5ee0703 100644 --- a/docs/source/settings.rst +++ b/docs/source/settings.rst @@ -1,6 +1,7 @@ - .. _settings: +.. Please update gunicorn/config.py instead. + Settings ======== diff --git a/gunicorn/config.py b/gunicorn/config.py index 97f75dde..ae9b5b5b 100644 --- a/gunicorn/config.py +++ b/gunicorn/config.py @@ -3,6 +3,8 @@ # This file is part of gunicorn released under the MIT license. # See the NOTICE for more information. +# Please remember to run "make -C docs html" after update "desc" attributes. + import copy import grp import inspect @@ -457,7 +459,6 @@ def get_default_config_file(): return None -# Please remember to run "make html" in docs/ after update "desc" attributes. class ConfigFile(Setting): name = "config" section = "Config File"