summaryrefslogtreecommitdiff
path: root/docs/api/i18n.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/i18n.rst')
-rw-r--r--docs/api/i18n.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/api/i18n.rst b/docs/api/i18n.rst
new file mode 100644
index 000000000..6562bb13b
--- /dev/null
+++ b/docs/api/i18n.rst
@@ -0,0 +1,31 @@
+.. _i18n_module:
+
+:mod:`repoze.bfg.i18n`
+----------------------
+
+.. automodule:: repoze.bfg.i18n
+
+ .. autoclass:: TranslationString
+
+ .. autoclass:: TranslationStringFactory
+
+ .. autoclass:: Localizer
+ :members:
+
+ .. attribute:: locale_name
+
+ The locale name for this localizer (e.g. ``en`` or ``en_US``).
+
+ .. autofunction:: get_localizer
+
+ .. autofunction:: negotiate_locale_name
+
+ .. autofunction:: get_locale_name
+
+ .. autofunction:: default_locale_negotiator
+
+See :ref:`i18n_chapter` for more information about using
+:mod:`repoze.bfg` internationalization and localization services
+within an application.
+
+