summaryrefslogtreecommitdiff
path: root/docs/api
diff options
context:
space:
mode:
authorArmin Ronacher <armin.ronacher@active-4.com>2013-07-25 23:22:44 +0200
committerArmin Ronacher <armin.ronacher@active-4.com>2013-07-25 23:22:44 +0200
commitc9fbb2c48e0b71052a8713d02ffe96006af882a6 (patch)
tree2c1e3e5b30251a5ef23adeb8b8e8615c17ee7ae5 /docs/api
parent96539780ded7f3104f189ba4bb3f076bf66700f9 (diff)
downloadbabel-c9fbb2c48e0b71052a8713d02ffe96006af882a6.tar.gz
Added messages docs
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/index.rst1
-rw-r--r--docs/api/messages.rst23
2 files changed, 24 insertions, 0 deletions
diff --git a/docs/api/index.rst b/docs/api/index.rst
index 9222cf1..208d4de 100644
--- a/docs/api/index.rst
+++ b/docs/api/index.rst
@@ -9,6 +9,7 @@ public API of Babel.
core
dates
+ messages
numbers
plural
support
diff --git a/docs/api/messages.rst b/docs/api/messages.rst
new file mode 100644
index 0000000..aed231e
--- /dev/null
+++ b/docs/api/messages.rst
@@ -0,0 +1,23 @@
+Messages and Catalogs
+=====================
+
+.. module:: babel.messages
+
+Babel provides functionality to work with message catalogs. There is more
+functionality than that available but some of it is currently only
+documented in the sourcecode as we have to decide what part of the API
+will become public and what should stay internal.
+
+Basic Interface
+---------------
+
+.. autoclass:: Message
+ :members:
+
+.. autoclass:: Catalog
+ :members:
+
+Exceptions
+----------
+
+.. autoexception:: TranslationError