diff options
| author | Robert Lehmann <mail@robertlehmann.de> | 2010-06-26 12:38:06 +0200 |
|---|---|---|
| committer | Robert Lehmann <mail@robertlehmann.de> | 2010-06-26 12:38:06 +0200 |
| commit | dee831cb0d87c43b6284fa2ff26f47fa2be3ff46 (patch) | |
| tree | 1f72f232fc4a46e4db9731281eac4e89e305944c /doc | |
| parent | a69753febcbc5acdb46406717f6ea7963583820c (diff) | |
| download | sphinx-dee831cb0d87c43b6284fa2ff26f47fa2be3ff46.tar.gz | |
Document gettext builder and create i18n docs.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/builders.rst | 12 | ||||
| -rw-r--r-- | doc/contents.rst | 1 | ||||
| -rw-r--r-- | doc/intl.rst | 11 |
3 files changed, 24 insertions, 0 deletions
diff --git a/doc/builders.rst b/doc/builders.rst index 6e90ccc6..5aefac44 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -220,6 +220,18 @@ Note that a direct PDF builder using ReportLab is available in `rst2pdf .. versionadded:: 0.5 +.. module:: sphinx.builders.intl +.. class:: MessageCatalogBuilder + + This builder produces a message catalog file for each reST file or + subdirectory. + + See the documentation on :ref:`internationalization <intl>` for further reference. + + Its name is ``gettext``. + + .. versionadded:: 1.XXX + .. module:: sphinx.builders.changes .. class:: ChangesBuilder diff --git a/doc/contents.rst b/doc/contents.rst index 079f93f2..c8c0988b 100644 --- a/doc/contents.rst +++ b/doc/contents.rst @@ -14,6 +14,7 @@ Sphinx documentation contents domains builders config + intl theming templating extensions diff --git a/doc/intl.rst b/doc/intl.rst new file mode 100644 index 00000000..8722177d --- /dev/null +++ b/doc/intl.rst @@ -0,0 +1,11 @@ +.. _intl: + +Internationalization +==================== + +.. versionadded:: 1.XXX + +Complementary to translations provided for internal messages such as navigation +bars Sphinx provides mechanisms facilitating *document* translations in itself. +It relies on the existing configuration values :confval:`language` and +:confval:`locale_dirs`. |