From ea0a49a8176a43f1394658e2b59b0bb5af60c02f Mon Sep 17 00:00:00 2001
From: Laurent Peuch <cortex@worlddomination.be>
Date: Wed, 26 Jul 2017 00:58:35 +0200
Subject: [PATCH] [doc] add some raw doc for m18n

---
 doc/index.rst |  1 +
 doc/m18n.rst  | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 39 insertions(+)

diff --git a/doc/index.rst b/doc/index.rst
index f856c03f..8090d743 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -16,6 +16,7 @@ a reference.
    :maxdepth: 2
    :caption: Contents:
 
+   m18n
    utils/filesystem
    utils/network
    utils/process
diff --git a/doc/m18n.rst b/doc/m18n.rst
index e69de29b..ff5d3581 100644
--- a/doc/m18n.rst
+++ b/doc/m18n.rst
@@ -0,0 +1,38 @@
+Translations using the m18n object
+==================================
+
+The moulinette provides a way to do translations and YunoHost uses it. This is
+done via the `m18n` object that you can import this way:
+
+::
+
+    from moulinette import m18n
+
+The `m18n` object comes with 2 method:
+
+* `m18n.n` to uses for translations within YunoHost
+* `m18n.g` to uses for translations within Moulinette itself
+
+Their API is identical.
+
+Here are example of uses:
+
+::
+
+    m18n.n('some_translation_key')
+    m18n.g('some_translation_key')
+
+    m18n.n('some_translation_key', string_formating_argument_1=some_variable)
+    m18n.g('some_translation_key', string_formating_argument_1=some_variable)
+
+The translation key must be present in `locales/en.json` of either YunoHost
+(for `.n`) or moulinette (for `.g`).
+
+Docstring
+---------
+
+As a reference, here are the docstrings of the m18n class:
+
+.. autoclass:: moulinette.core.Moulinette18n
+.. automethod:: moulinette.core.Moulinette18n.n
+.. automethod:: moulinette.core.Moulinette18n.g