Improve initial documentation

Provide more detailed guidelines based on the info we have in the
wiki at https://wiki.openstack.org/wiki/LoggingStandards#Guidelines

Provide API documentation for the gettextutils module.

Fix up some formatting issues with the contributing page that kept it
from being included in the table of contents.

Add a description to the README.

Other minor section and document title fixes, and remove unused pages.

Change-Id: I1e0a2be2918fe8f5d4194fc5a82b19edb225c1d0
This commit is contained in:
Doug Hellmann
2014-05-30 18:13:06 -04:00
parent 57e22f17e9
commit 5ce463c433
12 changed files with 304 additions and 41 deletions

View File

@@ -29,7 +29,8 @@ class TranslationHandler(handlers.MemoryHandler):
to forward LogRecord objects to after translating them. This handler
depends on Message objects being logged, instead of regular strings.
The handler can be configured declaratively in the logging.conf as follows:
The handler can be configured declaratively in the
``logging.conf`` as follows::
[handlers]
keys = translatedlog, translator
@@ -40,12 +41,13 @@ class TranslationHandler(handlers.MemoryHandler):
formatter = context
[handler_translator]
class = openstack.common.log.TranslationHandler
class = oslo.i18n.log.TranslationHandler
target = translatedlog
args = ('zh_CN',)
If the specified locale is not available in the system, the handler will
log in the default locale.
"""
def __init__(self, locale=None, target=None):