Skip to content

Commit

Permalink
Add documentation about gunicorn/config.py.
Browse files Browse the repository at this point in the history
Fixes #896.
  • Loading branch information
berkerpeksag committed Sep 23, 2014
1 parent 7f0c7c5 commit 5536a5f
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 2 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion docs/source/settings.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@

.. _settings:

.. Please update gunicorn/config.py instead.
Settings
========

Expand Down
3 changes: 2 additions & 1 deletion gunicorn/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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"
Expand Down

1 comment on commit 5536a5f

@collinanderson
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hah. This commit is for me. Thanks.

Please sign in to comment.